Skip to content

Commit 7955de3

Browse files
committed
docs(2.0): update extending section
1 parent b2e93af commit 7955de3

2 files changed

Lines changed: 18 additions & 17 deletions

File tree

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Mobile Tab Component
22

3-
![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/acpl/mobile-tab.svg)](https://packagist.org/packages/acpl/mobile-tab) [![Total Downloads](https://img.shields.io/packagist/dt/acpl/mobile-tab.svg)](https://packagist.org/packages/acpl/mobile-tab) [![GitHub Sponsors](https://img.shields.io/badge/Donate-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717)](https://github.com/android-com-pl/mobile-tab?sponsor=1)
3+
![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/acpl/mobile-tab.svg)](https://packagist.org/packages/acpl/mobile-tab) [![Total Downloads](https://img.shields.io/packagist/dt/acpl/mobile-tab.svg)](https://packagist.org/packages/acpl/mobile-tab/stats) [![GitHub Sponsors](https://img.shields.io/badge/Donate-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717)](https://github.com/android-com-pl/mobile-tab?sponsor=1)
44

55
A [Flarum](https://flarum.org) extension. Adds a bottom tab on mobile.
66

@@ -23,36 +23,35 @@ php flarum cache:clear
2323

2424
### Extending
2525

26+
> [!IMPORTANT]
27+
> These instructions are for Flarum 2.0.
28+
> For Flarum 1.x documentation, please refer to:
29+
> [Flarum 1.x Guide](https://github.com/android-com-pl/mobile-tab/tree/1.x?tab=readme-ov-file#extending)
30+
2631
You can add, modify, and delete items in the mobile tab using your own extension.
27-
Read: [https://docs.flarum.org/extend/extending-extensions/](https://docs.flarum.org/extend/extending-extensions/)
32+
Read: [https://docs.flarum.org/2.x/extend/extending-extensions](https://docs.flarum.org/2.x/extend/extending-extensions)
2833

29-
1. Install `acpl/mobile-tab` as your extension's composer dependency or add it as an [optional dependency](https://docs.flarum.org/extend/extending-extensions/#optional-dependencies) in your `composer.json`.
30-
2. Add `acpl-mobile-tab` to your extension's **webpack.config.js** to ensure proper bundling:
31-
```js
32-
const config = require("flarum-webpack-config");
34+
1. Install `acpl/mobile-tab` as your extension's composer dependency or add it as an [optional dependency](https://docs.flarum.org/2.x/extend/extending-extensions#optional-dependencies) in your `composer.json`.
3335

34-
module.exports = config({
35-
useExtensions: ["acpl-mobile-tab"],
36-
});
37-
```
38-
3. You can now import and use mobile tab components in your extension. Here are some **examples** of how to modify the mobile tab:
36+
2. You can now import and use mobile tab components in your extension. Here are some **examples** of how to modify the mobile tab:
3937
```jsx
40-
import { components } from "@acpl-mobile-tab";
4138
import { extend } from "flarum/common/extend";
39+
import LinkButton from 'flarum/common/components/LinkButton';
4240

43-
const { MobileTab, MobileTabItem } = components;
41+
import MobileTab from "ext:acpl/mobile-tab/forum/components/MobileTab";
4442

4543
export default () => {
4644
// Extend the items method of MobileTab prototype
4745
extend(MobileTab.prototype, "items", (items) => {
4846
// Add new item
4947
items.add(
5048
"following",
51-
<MobileTabItem
49+
<LinkButton
5250
href={app.route("following")}
5351
icon="fas fa-star"
54-
label={app.translator.trans("my-ext.forum.my-item")}
55-
/>,
52+
>
53+
{app.translator.trans("my-ext.forum.my-item")}
54+
</LinkButton>,
5655
90,
5756
);
5857

js/src/forum/components/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
import MobileTab from './MobileTab';
22
import MobileTabSessionDropdown from './MobileTabSessionDropdown';
33

4-
export const components = {
4+
const components = {
55
MobileTab,
66
MobileTabSessionDropdown,
77
};
8+
9+
export default components;

0 commit comments

Comments
 (0)