@muibook/components 1.0.10 → 1.0.12

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.
@@ -56,7 +56,6 @@ class f extends HTMLElement {
56
56
  :host {
57
57
  display: inline-block;
58
58
  width: 100%;
59
- position: relative;
60
59
  }
61
60
  label {
62
61
  font-size: var(--text-font-size);
@@ -183,10 +182,13 @@ class f extends HTMLElement {
183
182
  /*html*/
184
183
  `<label for="${o}" class="${s ? "vh" : ""}">${r}</label>`
185
184
  ) : ""}
186
- <select class="${h}" part="${this.partMap || ""}" name="${e}" id="${o}" ${u} ${c ? "disabled" : ""} >
187
- ${v}
188
- </select>
189
- <mui-icon-down-chevron class="chevron" size="x-small"></mui-icon-down-chevron>
185
+ <div style="position: relative;">
186
+ <select class="${h}" part="${this.partMap || ""}" name="${e}" id="${o}" ${u}
187
+ ${c ? "disabled" : ""}>
188
+ ${v}
189
+ </select>
190
+ <mui-icon-down-chevron class="chevron" size="x-small"></mui-icon-down-chevron>
191
+ </div>
190
192
  `
191
193
  );
192
194
  this.shadowRoot.innerHTML = p;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@muibook/components",
3
- "version": "1.0.10",
3
+ "version": "1.0.12",
4
4
  "description": "A library of MUI-based design system components.",
5
5
  "author": "Michael Trilford",
6
6
  "homepage": "https://muibook.com",
package/readme.md CHANGED
@@ -1,36 +1,60 @@
1
- # Muibook
1
+ # NPM Package 📦 – @muibook/components
2
2
 
3
- ## Muibook/Components (NPM)
3
+ Leverage reusable vanilla Web Components built with the Mui (MichaelUI) Design System in your project. Simply install the [@muibook/components](https://www.npmjs.com/package/@muibook/components?activeTab=readme) package to access a framework-agnostic, accessible, and customizable component library.
4
4
 
5
- A library of reusable vanilla Web Components designed with the MichaelUI design language. Perfect for building consistent, framework-agnostic design systems inspired by MichaelUI’s principles.
5
+ ```bash
6
+ npm install @muibook/components
7
+ ```
6
8
 
7
- - 📦 View on [npmjs.com](https://www.npmjs.com/package/@muibook/components?activeTab=readme)
8
- - 🔌 Framework-agnostic: works in any modern JavaScript environment
9
- - 🎨 Styled and structured according to MichaelUI guidelines
10
- - Lightweight, fast, and customisable
11
- - 🧱 Built for scalable and maintainable design systems
9
+ #### Usage
10
+
11
+ ```javascript
12
+ import "@muibook/components"; // All
13
+ import "@muibook/components/mui-body"; // Individual
14
+ ```
15
+
16
+ Links •
17
+ [npmjs.com](https://www.npmjs.com/package/@muibook/components?activeTab=readme) •
18
+ [Docs](https://muibook.com) •
19
+ [Usage](https://muibook.com) •
20
+ [Components](https://muibook.com)
12
21
 
13
22
  ---
14
23
 
15
- ## Create Mui App
24
+ # Create Mui App
25
+
26
+ Kickstart your project with a lightweight scaffold built on Vite. It comes preloaded with foundational CSS resets, a solid base structure, and design tokens ready to be customised for your brand.
16
27
 
17
- - Kickstart your project with a lightweight scaffold built on Vite. It comes preloaded with foundational CSS resets, a solid base structure, and design tokens ready to be customised for your brand.
18
- - Access a curated set of MUI Components, wrapped in a clean layout that highlights the Design System’s core building blocks—so you can start designing and building immediately.
19
- - Learn more at [Muibook.com](https://muibook.com/#/create-mui-app)
28
+ - Vite-powered: Lightning-fast development with HMR
29
+ - 🎨 Pre-configured theming: Design tokens and CSS custom properties
30
+ - 🧱 Component showcase: Curated set of MUI Components in a clean layout
31
+ - 📱 Responsive foundation: Mobile-first CSS resets and utilities
32
+ - 🔧 Customisable: Easy to adapt for your brand and requirements
33
+
34
+ Learn more at [Muibook.com](https://muibook.com/#/create-mui-app)
20
35
 
21
36
  ---
22
37
 
23
- ## Muibook Documentation
38
+ # Muibook Repository
39
+
40
+ Muibook is the home of the Mui Design System (MichaelUI) — native Web Components with clean, composable patterns that help you write less code.
24
41
 
25
- - Muibook is the home of the Mui Design System (MichaelUI) — native Web Components with clean, composable patterns that help you write less code
26
- - Learn more about [Muibook.com](https://muibook.com)
27
- - This project is powered by [Vite](https://vitejs.dev/) and uses TypeScript to provide a fast, modern development experience for building and previewing web components.
42
+ - 📖 Comprehensive guides: From basic usage to advanced customization
43
+ - 🎨 Design principles: Learn the MichaelUI design language
44
+ - 🔧 API reference: Detailed documentation for every component
45
+ - 💡 Best practices: Proven patterns for scalable design systems
46
+
47
+ Learn more about [Muibook.com](https://muibook.com)
28
48
 
29
49
  ---
30
50
 
31
- ## Start Development Server
51
+ ### Start Development Server
52
+
53
+ This project is powered by [Vite](https://vitejs.dev/) and uses TypeScript to provide a fast, modern development experience for building and previewing web components.
32
54
 
33
- `npm run dev`
55
+ ```bash
56
+ npm run dev
57
+ ```
34
58
 
35
59
  - Starts Vite in development mode
36
60
  - Opens the app at http://localhost:5173 (or next available port)
@@ -38,87 +62,115 @@ A library of reusable vanilla Web Components designed with the MichaelUI design
38
62
 
39
63
  ---
40
64
 
41
- ## Build Project
65
+ ### Build Project
42
66
 
43
- `npm run build`
67
+ ```bash
68
+ npm run build
69
+ ```
44
70
 
45
71
  - Compiles and bundles the project for production
46
- - Outputs optimized files into the dist/ directory
72
+ - Outputs optimised files into the dist/ directory
47
73
 
48
74
  ---
49
75
 
50
- ## Build Muibook
76
+ ### Build Muibook
51
77
 
52
- `npm run build:muibook`
78
+ ```bash
79
+ npm run build:muibook
80
+ ```
53
81
 
54
82
  - Builds the Muibook package using a custom Vite config (vite.muibook.config.ts)
55
83
  - Produces a minified CSS and JS build for documentation
56
84
 
57
85
  ---
58
86
 
59
- ## Preview Muibook Build
87
+ ### Preview Muibook Build
60
88
 
61
- `npm run preview:muibook`
89
+ ```bash
90
+ npm run preview:muibook
91
+ ```
62
92
 
63
93
  - Serves the minified Muibook build locally for previewing the compiled output
64
94
 
65
95
  ---
66
96
 
67
- ## Build Create Mui App
97
+ ### Build Create Mui App
68
98
 
69
- `npm run build:create-mui-app`
99
+ ```bash
100
+ npm run build:create-mui-app
101
+ ```
70
102
 
71
103
  - Builds the create-mui-app package using a custom Vite config (vite.create-mui-app.config.ts)
72
104
  - Produces a minified CSS and JS build for documentation
73
105
 
74
106
  ---
75
107
 
76
- ## Preview Create Mui App Build
108
+ ### Preview Create Mui App Build
77
109
 
78
- `npm run preview:create-mui-app`
110
+ ```bash
111
+ npm run preview:create-mui-app
112
+ ```
79
113
 
80
114
  - Serves the minified create-mui-app build locally for previewing the compiled output
81
115
 
82
116
  ---
83
117
 
84
- ## Setup
118
+ ### Setup
85
119
 
86
- Install dependencies:
120
+ #### Install dependencies:
87
121
 
88
- `npm install`
122
+ ```bash
123
+ npm install
124
+ ```
89
125
 
90
- TypeScript Support:
126
+ #### TypeScript Support:
91
127
 
92
- `npm install --save-dev @types/node`
128
+ ```bash
129
+ npm install --save-dev @types/node
130
+ ```
93
131
 
94
132
  ---
95
133
 
96
- ## VS Code Plug-in
134
+ ### VS Code Plug-in
97
135
 
98
- Install [es6-string-html](https://marketplace.visualstudio.com/items?itemName=Tobermory.es6-string-html)
136
+ Install [es6-string-html](https://marketplace.visualstudio.com/items?itemName=Tobermory.es6-string-html) for better HTML template literal syntax highlighting.
99
137
 
100
138
  ---
101
139
 
102
- ## Packages
140
+ ### Publishing
103
141
 
104
- Publish
142
+ #### Publish to NPM
105
143
 
106
- `npm publish`
144
+ ```bash
145
+ npm publish
146
+ ```
107
147
 
108
- Version Patch
148
+ #### Version Management
109
149
 
110
- `npm version patch`
150
+ ```bash
151
+ npm version patch # Increment patch version
152
+ npm version minor # Increment minor version
153
+ npm version major # Increment major version
154
+ ```
111
155
 
112
- Dry run
156
+ #### Test Before Publishing
113
157
 
114
- `npm pack --dry-run`
158
+ ```bash
159
+ npm pack --dry-run # Preview what will be published
160
+ ```
115
161
 
116
162
  ---
117
163
 
118
- ## Notes
164
+ ### Development Notes
119
165
 
120
166
  - Add any new components to `vite.config.ts` to include them in builds
121
167
  - The dist/ folder is published, while source code and src/muibook are excluded
122
168
  - Use the preview scripts to verify production builds before deployment
169
+ - Follow semantic versioning for releases
170
+
171
+ ---
172
+
173
+ ### License
123
174
 
124
- ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
175
+ - ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
176
+ - MIT License - see LICENSE file for details.