Skip to content

Commit fd89b20

Browse files
authored
Merge pull request #76 from prabhuignoto/restyled/new_1792023
Restyle chore: upgrade packages
2 parents d23d5bd + 3666218 commit fd89b20

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
- [Fixed Menu](#fixed-menu)
5959
- [🎨 Custom icon](#-custom-icon)
6060
- [🌈 Theme](#-theme)
61+
6162
- [📦 Build Setup](#-build-setup)
6263
- [🔨 Contributing](#-contributing)
6364
- [Built with](#built-with)
@@ -132,17 +133,17 @@ export default {
132133
133134
## Props
134135
135-
| Prop | Type | Description |
136-
| ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
137-
| dimension | number | dimension of the Menu Head `width x height` in pixels. |
138-
| position | String | initial position of the Menu Head. can be any one of the values `top left`, `top right`, `bottom left`, `bottom right` |
139-
| fixed | Boolean | disables dragging and the menu will be fixed. use the `position` prop to fix the menu position |
140-
| menu-dimension | Object | sets the `width` and `minimum` height of the Menu. |
141-
| menu-data | Object | data to generate the menu. refer to [populating the menu](#populating-the-menu) for usage details. |
142-
| on-selected | Function | hook that is called on selection. |
143-
| menu-style | String | can be `slide-out` or `accordion`.`slide-out` is the default menu style. |
144-
| flip-on-edges | Boolean | flips the menu content on the right edges of the screen. |
145-
| theme | Object | prop to customize the color schemes. refer [theme](#theme) for usage. |
136+
| Prop | Type | Description |
137+
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
138+
| dimension | number | dimension of the Menu Head `width x height` in pixels. |
139+
| position | String | initial position of the Menu Head. can be any one of the values `top left`, `top right`, `bottom left`, `bottom right` |
140+
| fixed | Boolean | disables dragging and the menu will be fixed. use the `position` prop to fix the menu position |
141+
| menu-dimension | Object | sets the `width` and `minimum` height of the Menu. |
142+
| menu-data | Object | data to generate the menu. refer to [populating the menu](#populating-the-menu) for usage details. |
143+
| on-selected | Function | hook that is called on selection. |
144+
| menu-style | String | can be `slide-out` or `accordion`.`slide-out` is the default menu style. |
145+
| flip-on-edges | Boolean | flips the menu content on the right edges of the screen. |
146+
| theme | Object | prop to customize the color schemes. refer [theme](#theme) for usage. |
146147
147148
### Position
148149
@@ -213,12 +214,12 @@ Use the `menu-data` prop to create simple or nested menus of your liking. `menu-
213214
214215
`MenuItem` properties
215216
216-
| property | description |
217-
| ----------- | --------------------------------------------------------------------- |
218-
| name | display name of the menu item. |
219-
| subMenu | data for the sub-menu |
220-
| disabled | disables the menu item |
221-
| divider | makes the item as a divider |
217+
| property | description |
218+
| -------- | ------------------------------ |
219+
| name | display name of the menu item. |
220+
| subMenu | data for the sub-menu |
221+
| disabled | disables the menu item |
222+
| divider | makes the item as a divider |
222223
223224
Here we create a simple Menu structure with 3 Menu items with no sub menus.
224225
@@ -393,7 +394,6 @@ export default defineComponent({
393394
});
394395
```
395396
396-
397397
### 🌈 Theme
398398
399399
Customize the color schemes with the `theme` prop.
@@ -414,7 +414,7 @@ Customize the color schemes with the `theme` prop.
414414
415415
## 📦 Build Setup
416416
417-
``` bash
417+
```bash
418418
# install dependencies
419419
pnpm install
420420

0 commit comments

Comments
 (0)