File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -29,6 +29,7 @@ This monorepo contains the following:
2929
3030### Private packages
31311 ) [ docs] ( https://github.com/michaelcozzolino/flyonui-vue/tree/2.x/packages/docs ) : The documentation of the ` Public Packages ` built with ` Vitepress ` .
32+ 2 ) [ scripts] ( https://github.com/michaelcozzolino/flyonui-vue/tree/2.x/packages/scripts ) : A set of useful scripts for development.
3233
3334## Credits 🤘
3435
Original file line number Diff line number Diff line change 11{
22 "name" : " flyonui-vue" ,
33 "type" : " module" ,
4- "version" : " 2.0 .0" ,
4+ "version" : " 2.1 .0" ,
55 "author" : " Michael Cozzolino" ,
66 "license" : " MIT" ,
77 "repository" : {
Original file line number Diff line number Diff line change 11import type { SidebarBadge , SidebarItem } from '@/.vitepress/theme/Components/Layout/Features/Sidebar/Types/Sidebar' ;
22import type { ComputedRef } from 'vue' ;
3- import { computed } from 'vue' ;
3+ import { computed } from 'vue' ;
44
55export function useSidebarItems ( ) : ComputedRef < SidebarItem [ ] > {
66 return computed ( ( ) : SidebarItem [ ] => {
7- const unreleasedBadge : SidebarBadge = {
7+ const _unreleasedBadge : SidebarBadge = {
88 color : 'warning' ,
99 text : 'Unreleased' ,
1010 } ;
@@ -45,7 +45,6 @@ export function useSidebarItems(): ComputedRef<SidebarItem[]> {
4545 text : 'Keyboard' ,
4646 to : '/content/keyboard' ,
4747 icon : 'mdi:keyboard-outline' ,
48- badge : unreleasedBadge ,
4948 children : [ ] ,
5049 } ,
5150 {
@@ -122,7 +121,6 @@ export function useSidebarItems(): ComputedRef<SidebarItem[]> {
122121 text : 'Pagination' ,
123122 to : '/navigations/pagination' ,
124123 icon : 'carbon:insert-page' ,
125- badge : unreleasedBadge ,
126124 children : [ ] ,
127125 } ,
128126 ] ,
@@ -192,7 +190,6 @@ export function useSidebarItems(): ComputedRef<SidebarItem[]> {
192190 text : 'Table' ,
193191 to : '/tables/table' ,
194192 icon : 'mdi:table' ,
195- badge : unreleasedBadge ,
196193 children : [ ] ,
197194 } ,
198195 ] ,
Original file line number Diff line number Diff line change 2020
2121## Illustrations
2222
23- ### Icon < Badge type = " warning " text = " Unreleased " />
23+ ### Icon
2424
2525<SelectDocs section =" with-icon " />
2626
27- ### Validation states < Badge type = " warning " text = " Unreleased " />
27+ ### Validation states
2828
2929<SelectDocs section =" validation-state " />
3030
31- ### Shapes < Badge type = " warning " text = " Unreleased " />
31+ ### Shapes
3232
3333<SelectDocs section =" shape " />
3434
35- ### Label and helper text < Badge type = " warning " text = " Unreleased " />
35+ ### Label and helper text
3636
3737<SelectDocs section =" with-label-and-helper-text " />
3838
39- ### Hidden label < Badge type = " warning " text = " Unreleased " />
39+ ### Hidden label
4040
4141<SelectDocs section =" hidden-label " />
4242
43- ### Disabled < Badge type = " warning " text = " Unreleased " />
43+ ### Disabled
4444
4545<SelectDocs section =" disabled " />
4646
47- ### Datalist < Badge type = " warning " text = " Unreleased " />
47+ ### Datalist
4848
4949When the input field is empty the selected option will automatically be null.
5050
5151<SelectDocs section =" datalist " />
5252
53- ### Optgroup < Badge type = " warning " text = " Unreleased " />
53+ ### Optgroup
5454
5555<SelectDocs section =" optgroup " />
5656
57- ## Advanced usage < Badge type = " warning " text = " Unreleased " />
57+ ## Advanced usage
5858
59- ### Ref usage < Badge type = " warning " text = " Unreleased " />
59+ ### Ref usage
6060
6161The ` useSelectedOption ` composables can take as second argument a ` MaybeRefOrGetter<number|string> ` , in most of the cases
6262the id of the selected option might come from an object ref or an id ref, in that case passing the writable ref
Original file line number Diff line number Diff line change @@ -32,11 +32,11 @@ The following component might have changes in future releases
3232
3333<MenuDocs section =" with-badge " />
3434
35- ### With active item (Vue Router) (Unreleased)
35+ ### With active item (Vue Router)
3636
3737<MenuDocs section =" with-active-item-vue-router " />
3838
39- ### With active item (External Router) (Unreleased)
39+ ### With active item (External Router)
4040
4141In case of external router, you need to pass a navigation props that contains a function to navigate to the item route
4242and an active path that will be used to highlight the active item.
Original file line number Diff line number Diff line change 1+ # flyonui-scrips
2+
3+ Useful scripts to simplify the development workflow:
4+
5+ 1 ) ` yarn generate:resolutions ` : It generates the right resolutions for the same packages being used in different monorepo.
6+ packages.
7+ 2 ) ` generate:components-api ` : It generates the api of the whole components, to be shown on the docs and exported from the
8+ ` core ` package into [ ComponentsApi.json] ( https://github.com/michaelcozzolino/flyonui-vue/tree/2.x/packages/docs/Api/Lib/ComponentsApi.json ) .
9+ ```
Original file line number Diff line number Diff line change 11{
2- "name" : " scripts" ,
2+ "name" : " flyonui-vue- scripts" ,
33 "type" : " module" ,
44 "devDependencies" : {
55 "fast-glob" : " ^3.3.3" ,
Original file line number Diff line number Diff line change @@ -4898,6 +4898,20 @@ __metadata:
48984898 languageName : unknown
48994899 linkType : soft
49004900
4901+ " flyonui-vue-scripts@workspace:packages/scripts " :
4902+ version : 0.0.0-use.local
4903+ resolution : " flyonui-vue-scripts@workspace:packages/scripts"
4904+ dependencies :
4905+ fast-glob : " npm:^3.3.3"
4906+ flyonui : " npm:^2.4.1"
4907+ flyonui-vue : " workspace:*"
4908+ typescript : " npm:^5.9.3"
4909+ vue-component-meta : " npm:^3.1.0"
4910+ vue-component-type-helpers : " npm:^3.1.0"
4911+ vue-tsc : " npm:^3.1.0"
4912+ languageName : unknown
4913+ linkType : soft
4914+
49014915" flyonui-vue@workspace:*, flyonui-vue@workspace:packages/core " :
49024916 version : 0.0.0-use.local
49034917 resolution : " flyonui-vue@workspace:packages/core"
@@ -8103,20 +8117,6 @@ __metadata:
81038117 languageName : node
81048118 linkType : hard
81058119
8106- " scripts@workspace:packages/scripts " :
8107- version : 0.0.0-use.local
8108- resolution : " scripts@workspace:packages/scripts"
8109- dependencies :
8110- fast-glob : " npm:^3.3.3"
8111- flyonui : " npm:^2.4.1"
8112- flyonui-vue : " workspace:*"
8113- typescript : " npm:^5.9.3"
8114- vue-component-meta : " npm:^3.1.0"
8115- vue-component-type-helpers : " npm:^3.1.0"
8116- vue-tsc : " npm:^3.1.0"
8117- languageName : unknown
8118- linkType : soft
8119-
81208120" scslre@npm:^0.3.0 " :
81218121 version : 0.3.0
81228122 resolution : " scslre@npm:0.3.0"
You can’t perform that action at this time.
0 commit comments