@prefabs.tech/vue3-layout 0.32.0 → 0.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -32
- package/dist/PrefabsTechVue3Layout.es.js +1595 -18
- package/dist/PrefabsTechVue3Layout.umd.js +1 -1
- package/dist/src/Layout.vue.d.ts +8 -5
- package/dist/src/Layout.vue.d.ts.map +1 -1
- package/dist/src/components/AppFooter.vue.d.ts +9 -6
- package/dist/src/components/AppFooter.vue.d.ts.map +1 -1
- package/dist/src/components/AppHeader.vue.d.ts +15 -9
- package/dist/src/components/AppHeader.vue.d.ts.map +1 -1
- package/dist/src/components/Copyright.vue.d.ts +3 -2
- package/dist/src/components/Copyright.vue.d.ts.map +1 -1
- package/dist/src/components/Logo.vue.d.ts +5 -4
- package/dist/src/components/Logo.vue.d.ts.map +1 -1
- package/dist/src/components/MainMenu.vue.d.ts +5 -4
- package/dist/src/components/MainMenu.vue.d.ts.map +1 -1
- package/dist/src/components/NavMenu.vue.d.ts +7 -4
- package/dist/src/components/NavMenu.vue.d.ts.map +1 -1
- package/dist/src/components/NavMenuItem.vue.d.ts +7 -6
- package/dist/src/components/NavMenuItem.vue.d.ts.map +1 -1
- package/dist/src/components/Sidebar.vue.d.ts +34 -12
- package/dist/src/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/src/components/StickyCollapsibleFooter.vue.d.ts +5 -4
- package/dist/src/components/StickyCollapsibleFooter.vue.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/layouts/BasicLayout.vue.d.ts +25 -14
- package/dist/src/layouts/BasicLayout.vue.d.ts.map +1 -1
- package/dist/src/layouts/NullLayout.vue.d.ts +2 -1
- package/dist/src/layouts/NullLayout.vue.d.ts.map +1 -1
- package/dist/src/layouts/SidebarHeaderLayout.vue.d.ts +26 -21
- package/dist/src/layouts/SidebarHeaderLayout.vue.d.ts.map +1 -1
- package/dist/src/layouts/SidebarOnlyLayout.vue.d.ts +20 -12
- package/dist/src/layouts/SidebarOnlyLayout.vue.d.ts.map +1 -1
- package/dist/src/types/config.d.ts +1 -1
- package/dist/src/types/config.d.ts.map +1 -1
- package/dist/src/types/menu.d.ts +3 -3
- package/dist/src/types/menu.d.ts.map +1 -1
- package/dist/vue3-layout.css +2 -1
- package/package.json +36 -29
- package/dist/NavMenuItem-faWUzlfY.js +0 -4
- package/dist/index-DwdGhXMf.js +0 -1941
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Requirements
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
- `@prefabs.tech/vue3-config: >= 0.6.5`
|
|
6
|
+
- `vue: >= 3.2`
|
|
7
|
+
- `vue-router: >= 4.0`
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
@@ -45,8 +45,8 @@ app.mount("#app");
|
|
|
45
45
|
|
|
46
46
|
### App.vue
|
|
47
47
|
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
- Wrap your router view in the `Layout` component.
|
|
49
|
+
- Optionnally, set a default layout. You can use one of our built-in layouts, or create your own. The default layout will be applied to all routes for which no layout is set.
|
|
50
50
|
|
|
51
51
|
```vue
|
|
52
52
|
<template>
|
|
@@ -105,41 +105,40 @@ export default router;
|
|
|
105
105
|
|
|
106
106
|
## Configuration
|
|
107
107
|
|
|
108
|
-
| Name
|
|
109
|
-
|
|
110
|
-
| `homeRoute`
|
|
111
|
-
| `logo` `string` | The path to the logo
|
|
112
|
-
| `mainMenu`
|
|
113
|
-
|
|
108
|
+
| Name | Type | Description | Default value |
|
|
109
|
+
| --------------- | ------------------------------------ | ------------------------------------------------------------------------------ | ------------- |
|
|
110
|
+
| `homeRoute` | `string` | The name of the "home" route, ie the route that points to your app's home page | `home` |
|
|
111
|
+
| `logo` `string` | The path to the logo | `/logo.png` |
|
|
112
|
+
| `mainMenu` | `{ name: string; route: string; }[]` | An array of items to display in the app header's main menu | none |
|
|
114
113
|
|
|
115
114
|
## CSS Variables
|
|
116
115
|
|
|
117
116
|
### Basic layout
|
|
118
117
|
|
|
119
|
-
| Name
|
|
120
|
-
|
|
121
|
-
| `layout-basic-gap`
|
|
122
|
-
| `layout-basic-max-width`
|
|
123
|
-
| `layout-basic-padding-left`
|
|
124
|
-
| `layout-basic-padding-right` | Right padding for header, main and footer elements | `0.8rem`
|
|
118
|
+
| Name | Description | Default value |
|
|
119
|
+
| ---------------------------- | -------------------------------------------------- | ------------- |
|
|
120
|
+
| `layout-basic-gap` | Size of basic layout flex-box gap | `1rem` |
|
|
121
|
+
| `layout-basic-max-width` | Maximum width of header, main and footer elements | `1200px` |
|
|
122
|
+
| `layout-basic-padding-left` | Left padding for header, main and footer elements | `0.8rem` |
|
|
123
|
+
| `layout-basic-padding-right` | Right padding for header, main and footer elements | `0.8rem` |
|
|
125
124
|
|
|
126
125
|
### AppHeader
|
|
127
126
|
|
|
128
|
-
| Name
|
|
129
|
-
|
|
130
|
-
| `header-bg-color`
|
|
131
|
-
| `header-border-color`
|
|
132
|
-
| `header-font-size`
|
|
133
|
-
| `header-padding-bottom` | Bottom padding for header
|
|
134
|
-
| `header-padding-top`
|
|
127
|
+
| Name | Description | Default value |
|
|
128
|
+
| ----------------------- | ------------------------------- | ------------- |
|
|
129
|
+
| `header-bg-color` | Color of header background | `transparent` |
|
|
130
|
+
| `header-border-color` | Color of header (bottom) border | `#4169e1` |
|
|
131
|
+
| `header-font-size` | Font size of header text | `1rem` |
|
|
132
|
+
| `header-padding-bottom` | Bottom padding for header | `0.8rem` |
|
|
133
|
+
| `header-padding-top` | Top padding for header | `0.8rem` |
|
|
135
134
|
|
|
136
135
|
### App footer
|
|
137
136
|
|
|
138
|
-
| Name
|
|
139
|
-
|
|
140
|
-
| `footer-bg-color`
|
|
141
|
-
| `footer-border-color`
|
|
142
|
-
| `footer-font-size`
|
|
143
|
-
| `footer-gap`
|
|
144
|
-
| `footer-padding-bottom` | Bottom padding for footer
|
|
145
|
-
| `footer-padding-top`
|
|
137
|
+
| Name | Description | Default value |
|
|
138
|
+
| ----------------------- | ---------------------------- | ------------- |
|
|
139
|
+
| `footer-bg-color` | Color of footer background | `transparent` |
|
|
140
|
+
| `footer-border-color` | Color of footer (top) border | `#4169e1` |
|
|
141
|
+
| `footer-font-size` | Font size of footer text | `1rem` |
|
|
142
|
+
| `footer-gap` | Size of footer flex-box gap | `0.5rem` |
|
|
143
|
+
| `footer-padding-bottom` | Bottom padding for footer | `0.8rem` |
|
|
144
|
+
| `footer-padding-top` | Top padding for footer | `0.8rem` |
|