@solid-design-system/mcp 6.30.0 → 7.0.0-next.10
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/CHANGELOG.md +33 -0
- package/metadata/packages/components/docs/installation.md +9 -117
- package/metadata/packages/components/docs/usage.md +4 -4
- package/metadata/packages/components/sd-dialog/stories/headline.md +3 -1
- package/metadata/packages/components/sd-dialog/stories/no-close-button.md +3 -1
- package/metadata/packages/components/sd-dialog/stories/open.md +12 -8
- package/metadata/packages/components/sd-drawer/info.md +1 -2
- package/metadata/packages/components/sd-header/info.md +4 -2
- package/metadata/packages/components/sd-header/stories/shadow.md +9 -0
- package/metadata/packages/components/sd-icon/stories/custom-libraries.md +1 -1
- package/metadata/packages/components/sd-input/info.md +1 -0
- package/metadata/packages/components/sd-notification/stories/duration.md +5 -0
- package/metadata/packages/components/sd-tag/info.md +1 -1
- package/metadata/packages/components/sd-textarea/info.md +1 -1
- package/metadata/packages/icons/default/system.json +23 -23
- package/metadata/packages/quickstart/docs/quickstart.md +9 -27
- package/metadata/packages/styles/docs/installation.md +8 -56
- package/metadata/packages/styles/sd-chip/info.md +12 -8
- package/metadata/packages/styles/sd-chip/stories/{variants.md → color.md} +8 -10
- package/metadata/packages/styles/sd-chip/stories/outlined.md +8 -0
- package/metadata/packages/styles/sd-chip/stories/shade.md +17 -0
- package/metadata/packages/styles/sd-chip/stories/sharp.md +8 -0
- package/metadata/packages/styles/sd-chip/stories/size.md +8 -0
- package/metadata/packages/styles/sd-hidden-links/stories/surrounding-content.md +1 -1
- package/metadata/packages/templates/badge.md +1 -1
- package/metadata/packages/templates/bottom-navigation.md +2 -4
- package/metadata/packages/templates/breadcrumb.md +1 -1
- package/metadata/packages/templates/dialog.md +0 -10
- package/metadata/packages/templates/header-navigation.md +6 -6
- package/metadata/packages/templates/status-badge.md +3 -3
- package/metadata/packages/templates/teaser.md +20 -14
- package/metadata/packages/tokens/docs/installation.md +2 -23
- package/metadata/packages/tokens/docs/usage.md +3 -27
- package/metadata/packages/tokens/tokens.json +4 -0
- package/package.json +4 -4
- package/metadata/packages/components/sd-spinner/info.md +0 -53
- package/metadata/packages/components/sd-spinner/stories/size.md +0 -15
- package/metadata/packages/components/sd-spinner/stories/variants.md +0 -43
- package/metadata/packages/styles/sd-flag/info.md +0 -45
- package/metadata/packages/styles/sd-flag/stories/variants.md +0 -40
- package/metadata/packages/templates/flag.md +0 -38
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 7.0.0-next.10
|
|
4
|
+
|
|
5
|
+
## 7.0.0-next.9
|
|
6
|
+
|
|
7
|
+
## 7.0.0-next.8
|
|
8
|
+
|
|
9
|
+
### Major Changes
|
|
10
|
+
|
|
11
|
+
- Consolidated `sd-chip` and `sd-flag`: _[`#3267`](https://github.com/solid-design-system/solid/pull/3267) [`12db708`](https://github.com/solid-design-system/solid/commit/12db708ea227bc2ce2a7835d12190ee1ae40f891) [@auroraVasconcelos](https://github.com/auroraVasconcelos)_
|
|
12
|
+
|
|
13
|
+
- Removed the `sd-flag` style.
|
|
14
|
+
- Added `sd-chip--color-{primary,neutral,white}`, `sd-chip--shade-{subtle,low,medium,high}`, `sd-chip--size-{sm,lg}`, `sd-chip--outline` and `sd-chip--sharp` classes.
|
|
15
|
+
|
|
16
|
+
## 7.0.0-next.7
|
|
17
|
+
|
|
18
|
+
## 7.0.0-next.6
|
|
19
|
+
|
|
20
|
+
## 7.0.0-next.5
|
|
21
|
+
|
|
22
|
+
## 7.0.0-next.4
|
|
23
|
+
|
|
24
|
+
## 7.0.0-next.3
|
|
25
|
+
|
|
26
|
+
## 7.0.0-next.2
|
|
27
|
+
|
|
3
28
|
## 6.30.0
|
|
4
29
|
|
|
5
30
|
### Minor Changes
|
|
@@ -16,6 +41,14 @@
|
|
|
16
41
|
|
|
17
42
|
- Updated dependencies. See details in the Pull Request _[`#3163`](https://github.com/solid-design-system/solid/pull/3163) [`91ff1c8`](https://github.com/solid-design-system/solid/commit/91ff1c81831fb3522c534306a61b8a5be3562f64) [@rahulsuvarna18](https://github.com/rahulsuvarna18)_
|
|
18
43
|
|
|
44
|
+
## 7.0.0-next.1
|
|
45
|
+
|
|
46
|
+
### Patch Changes
|
|
47
|
+
|
|
48
|
+
- Fix versioned icons to work with next versions. _[`#3186`](https://github.com/solid-design-system/solid/pull/3186) [`30af3ad`](https://github.com/solid-design-system/solid/commit/30af3ad6d2e8daebeaa9d6a863fdd5794a015da9) [@auroraVasconcelos](https://github.com/auroraVasconcelos)_
|
|
49
|
+
|
|
50
|
+
## 7.0.0-next.0
|
|
51
|
+
|
|
19
52
|
## 6.28.1
|
|
20
53
|
|
|
21
54
|
## 6.28.0
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Installation
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Solid Components is installed via npm. For environments without a bundler, see [CDN Hosting](?path=/docs/docs-general-cdn-hosting--docs).
|
|
4
4
|
|
|
5
|
-
<sd-notification
|
|
5
|
+
<sd-notification variant="info" open id="versioning-info">
|
|
6
6
|
The `components`, `styles`, and `tokens` packages now always share the same version. We use fixed versioning to keep
|
|
7
7
|
them fully in sync, so every release updates all three packages, even if only one of them changed. Make sure to
|
|
8
8
|
install or update them using the same version number.
|
|
@@ -40,98 +40,9 @@ Keep the following in mind for nested components:
|
|
|
40
40
|
- _Slotted components_, which are added by your app or website, are not automatically versioned. You need to version them yourself if necessary.
|
|
41
41
|
- _Nested components_, which are generated by the component itself, are automatically versioned (e.g., `sd-%DASHED-COMPONENTS-VERSION%-button` will generate an `sd-%DASHED-COMPONENTS-VERSION%-spinner` when in the loading state).
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Installation
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
The bundle registers all Solid Components in a single file. If you're using many Solid Components, this is the most performant way to load and hydrate them. Still, you should ensure that other applications are not loading components with the same tag names via an additional CDN or npm package. This therefore makes most sense in e. g. a CMS context.
|
|
48
|
-
You can use the following script tag to load all components:
|
|
49
|
-
|
|
50
|
-
<sd-tab-group>
|
|
51
|
-
{/* prettier-ignore */}
|
|
52
|
-
<sd-tab slot="nav" panel="unversioned"> Unversioned </sd-tab>
|
|
53
|
-
{/* prettier-ignore */}
|
|
54
|
-
<sd-tab slot="nav" panel="versioned"> Versioned </sd-tab>
|
|
55
|
-
<sd-tab-panel name="unversioned">
|
|
56
|
-
```html
|
|
57
|
-
<link
|
|
58
|
-
rel="stylesheet"
|
|
59
|
-
href="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.css"
|
|
60
|
-
/>
|
|
61
|
-
<link
|
|
62
|
-
rel="stylesheet"
|
|
63
|
-
href="https://solid-design-system.fe.union-investment.de/tokens/%TOKENS-VERSION%/cdn/themes/ui-light/ui-light.css"
|
|
64
|
-
/>
|
|
65
|
-
<script
|
|
66
|
-
type="module"
|
|
67
|
-
src="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.bundle.js"
|
|
68
|
-
></script>
|
|
69
|
-
```
|
|
70
|
-
</sd-tab-panel>
|
|
71
|
-
<sd-tab-panel name="versioned">
|
|
72
|
-
```html
|
|
73
|
-
<link
|
|
74
|
-
rel="stylesheet"
|
|
75
|
-
href="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn-versioned/solid-components.css"
|
|
76
|
-
/>
|
|
77
|
-
<link
|
|
78
|
-
rel="stylesheet"
|
|
79
|
-
href="https://solid-design-system.fe.union-investment.de/tokens/%TOKENS-VERSION%/cdn/themes/ui-light/ui-light.css"
|
|
80
|
-
/>
|
|
81
|
-
<script
|
|
82
|
-
type="module"
|
|
83
|
-
src="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn-versioned/solid-components.bundle.js"
|
|
84
|
-
></script>
|
|
85
|
-
```
|
|
86
|
-
</sd-tab-panel>
|
|
87
|
-
</sd-tab-group>
|
|
88
|
-
|
|
89
|
-
### ESM
|
|
90
|
-
|
|
91
|
-
The CDN loader registers all Solid elements up front. Note that, if you're only using a handful of components, it could be more efficient [cherry pick](#cherry-picking) components if you want to load specific ones up front.
|
|
92
|
-
|
|
93
|
-
<sd-tab-group>
|
|
94
|
-
{/* prettier-ignore */}
|
|
95
|
-
<sd-tab slot="nav" panel="unversioned">Unversioned</sd-tab>
|
|
96
|
-
{/* prettier-ignore */}
|
|
97
|
-
<sd-tab slot="nav" panel="versioned">Versioned</sd-tab>
|
|
98
|
-
<sd-tab-panel name="unversioned">
|
|
99
|
-
```html
|
|
100
|
-
<link
|
|
101
|
-
rel="stylesheet"
|
|
102
|
-
href="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.css"
|
|
103
|
-
/>
|
|
104
|
-
<link
|
|
105
|
-
rel="stylesheet"
|
|
106
|
-
href="https://solid-design-system.fe.union-investment.de/tokens/%TOKENS-VERSION%/cdn/themes/ui-light/ui-light.css"
|
|
107
|
-
/>
|
|
108
|
-
<script
|
|
109
|
-
type="module"
|
|
110
|
-
src="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.js"
|
|
111
|
-
></script>
|
|
112
|
-
```
|
|
113
|
-
</sd-tab-panel>
|
|
114
|
-
<sd-tab-panel name="versioned">
|
|
115
|
-
```html
|
|
116
|
-
<link
|
|
117
|
-
rel="stylesheet"
|
|
118
|
-
href="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn-versioned/solid-components.css"
|
|
119
|
-
/>
|
|
120
|
-
<link
|
|
121
|
-
rel="stylesheet"
|
|
122
|
-
href="https://solid-design-system.fe.union-investment.de/tokens/%TOKENS-VERSION%/cdn/themes/ui-light/ui-light.css"
|
|
123
|
-
/>
|
|
124
|
-
<script
|
|
125
|
-
type="module"
|
|
126
|
-
src="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn-versioned/solid-components.js"
|
|
127
|
-
></script>
|
|
128
|
-
```
|
|
129
|
-
</sd-tab-panel>
|
|
130
|
-
</sd-tab-group>
|
|
131
|
-
|
|
132
|
-
## npm installation
|
|
133
|
-
|
|
134
|
-
If you don't want to use the CDN, you can install Solid Components from npm with the following command.
|
|
45
|
+
Install Solid Components from npm:
|
|
135
46
|
|
|
136
47
|
```bash
|
|
137
48
|
npm install @solid-design-system/components @solid-design-system/tokens
|
|
@@ -166,7 +77,7 @@ Alternatively, [you can use a bundler](#bundling).
|
|
|
166
77
|
|
|
167
78
|
## Cherry Picking
|
|
168
79
|
|
|
169
|
-
Cherry picking
|
|
80
|
+
Cherry picking loads only the components you need up front, limiting the number of files the browser has to download. The disadvantage is that you need to import each individual component.
|
|
170
81
|
|
|
171
82
|
Here's an example that loads only the button component. Again, if you're not using a module resolver, you'll need to adjust the path to point to the folder Solid is in.
|
|
172
83
|
|
|
@@ -209,7 +120,7 @@ You can copy and paste the code to import a component from the "Importing" secti
|
|
|
209
120
|
|
|
210
121
|
## Bundling
|
|
211
122
|
|
|
212
|
-
Solid Components are distributed as a collection of standard ES modules that [all modern browsers can understand](https://caniuse.com/es6-module). However, importing a lot of modules can result in a lot of HTTP requests and potentially longer load times.
|
|
123
|
+
Solid Components are distributed as a collection of standard ES modules that [all modern browsers can understand](https://caniuse.com/es6-module). However, importing a lot of modules can result in a lot of HTTP requests and potentially longer load times. You can optimize your imports with a bundler.
|
|
213
124
|
|
|
214
125
|
To use Solid with a bundler, first install Solid along with your bundler of choice.
|
|
215
126
|
|
|
@@ -245,27 +156,8 @@ Once your bundler is configured, you'll be able to import Solid components and u
|
|
|
245
156
|
|
|
246
157
|
> Component modules include side effects for registration purposes. Because of this, importing directly from `@solid-design-system/components` may result in a larger bundle size than necessary. For optimal tree shaking, always cherry pick, i.e. import components and utilities from their respective files, as shown above.
|
|
247
158
|
|
|
248
|
-
##
|
|
159
|
+
## cdn/ vs dist/
|
|
249
160
|
|
|
250
|
-
|
|
161
|
+
The package ships both `cdn/` and `dist/` artifacts. The `/cdn` files are pre-bundled with all dependencies inlined. The `/dist` files are not pre-bundled, allowing your bundler to deduplicate shared dependencies for a smaller total bundle.
|
|
251
162
|
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
<sd-tab-group>
|
|
255
|
-
{/* prettier-ignore */}
|
|
256
|
-
<sd-tab slot="nav" panel="unversioned">Unversioned</sd-tab>
|
|
257
|
-
{/* prettier-ignore */}
|
|
258
|
-
<sd-tab slot="nav" panel="versioned">Versioned</sd-tab>
|
|
259
|
-
<sd-tab-panel name="unversioned">
|
|
260
|
-
|
|
261
|
-
- `@solid-design-system/components/cdn` is for CDN users
|
|
262
|
-
- `@solid-design-system/components/dist` is for npm users
|
|
263
|
-
|
|
264
|
-
</sd-tab-panel>
|
|
265
|
-
<sd-tab-panel name="versioned">
|
|
266
|
-
|
|
267
|
-
- `@solid-design-system/components/cdn-versioned` is for CDN users
|
|
268
|
-
- `@solid-design-system/components/dist-versioned` is for npm users
|
|
269
|
-
|
|
270
|
-
</sd-tab-panel>
|
|
271
|
-
</sd-tab-group>
|
|
163
|
+
Use `/dist` with a bundler (recommended). Use `/cdn` only when hosting on your own CDN without build tooling — see [CDN Hosting](?path=/docs/general-cdn-hosting--docs).
|
|
@@ -94,10 +94,10 @@ Custom elements cannot have self-closing tags. Similar to `<script>` and `<texta
|
|
|
94
94
|
|
|
95
95
|
```html
|
|
96
96
|
<!-- Don't do this -->
|
|
97
|
-
<sd-
|
|
97
|
+
<sd-button />
|
|
98
98
|
|
|
99
99
|
<!-- Always do this -->
|
|
100
|
-
<sd-
|
|
100
|
+
<sd-button></sd-button>
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
### Differences from Native Elements
|
|
@@ -142,10 +142,10 @@ A way to use this method is to hide the `<body>` with `opacity: 0` and add a cla
|
|
|
142
142
|
await Promise.allSettled([
|
|
143
143
|
customElements.whenDefined('sd-button'),
|
|
144
144
|
customElements.whenDefined('sd-icon'),
|
|
145
|
-
customElements.whenDefined('sd-
|
|
145
|
+
customElements.whenDefined('sd-loader')
|
|
146
146
|
]);
|
|
147
147
|
|
|
148
|
-
// Button, icon and
|
|
148
|
+
// Button, icon and loader are registered now! Add
|
|
149
149
|
// the `ready` class so the UI fades in.
|
|
150
150
|
document.body.classList.add('ready');
|
|
151
151
|
</script>
|
|
@@ -8,7 +8,9 @@ Use the `headline` attribute to set the headline of the dialog. If you need to u
|
|
|
8
8
|
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et
|
|
9
9
|
dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam.
|
|
10
10
|
</p>
|
|
11
|
-
<
|
|
11
|
+
<div slot="footer" class="flex sm:justify-end gap-4">
|
|
12
|
+
<sd-button>Button</sd-button>
|
|
13
|
+
</div>
|
|
12
14
|
</sd-dialog>
|
|
13
15
|
</div>
|
|
14
16
|
<script type="module">
|
|
@@ -9,7 +9,9 @@ Use the `no-close-button` attribute to hide the close button in the dialog.
|
|
|
9
9
|
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et
|
|
10
10
|
dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam.
|
|
11
11
|
</p>
|
|
12
|
-
<
|
|
12
|
+
<div slot="footer" class="flex sm:justify-end gap-4">
|
|
13
|
+
<sd-button class="close-button" variant="primary">Button</sd-button>
|
|
14
|
+
</div>
|
|
13
15
|
</sd-dialog>
|
|
14
16
|
</div>
|
|
15
17
|
|
|
@@ -8,11 +8,6 @@
|
|
|
8
8
|
tags: ['!dev', 'autodocs'],
|
|
9
9
|
args: overrideArgs([
|
|
10
10
|
{
|
|
11
|
-
type: 'attribute',
|
|
12
|
-
name: 'open',
|
|
13
|
-
value: true
|
|
14
|
-
},
|
|
15
|
-
{
|
|
16
11
|
type: 'slot',
|
|
17
12
|
name: 'default',
|
|
18
13
|
value: `<div class="slot slot--border slot--text h-16 w-full">Default slot</div>`
|
|
@@ -39,12 +34,19 @@
|
|
|
39
34
|
};
|
|
40
35
|
export const Default = {
|
|
41
36
|
render: (args: any) => {
|
|
42
|
-
return html`
|
|
37
|
+
return html`
|
|
38
|
+
<sd-button id="open-default-dialog">Open Dialog</sd-button>
|
|
43
39
|
${generateTemplate({
|
|
44
40
|
args
|
|
45
41
|
})}
|
|
46
42
|
|
|
47
|
-
|
|
43
|
+
<script>
|
|
44
|
+
document.querySelector('#open-default-dialog').addEventListener('click', () => {
|
|
45
|
+
document.querySelector('sd-dialog').show();
|
|
46
|
+
});
|
|
47
|
+
</script>
|
|
48
|
+
|
|
49
|
+
`;
|
|
48
50
|
}
|
|
49
51
|
};
|
|
50
52
|
/**
|
|
@@ -59,7 +61,9 @@ Use the `open` attribute to show the dialog.
|
|
|
59
61
|
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et
|
|
60
62
|
dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam.
|
|
61
63
|
</p>
|
|
62
|
-
<
|
|
64
|
+
<div slot="footer" class="flex sm:justify-end gap-4">
|
|
65
|
+
<sd-button>Button</sd-button>
|
|
66
|
+
</div>
|
|
63
67
|
</sd-dialog>
|
|
64
68
|
</div>
|
|
65
69
|
<script type="module">
|
|
@@ -19,7 +19,6 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
19
19
|
- prop.label: string, default='' — You should always include a relevant label even when using
|
|
20
20
|
`no-header`, as it is required for proper accessibility.
|
|
21
21
|
- prop.placement: 'end'|'start', default='end' — The direction from which the drawer will open.
|
|
22
|
-
- prop.contained: boolean, default=false — By default, the drawer slides out of its containing block (the viewport). Contained is a hidden feature used only for testing purposes. Please do not use it in production as it will likely change.
|
|
23
22
|
- prop.noHeader [attr: no-header]: boolean, default=false — Removes the header. This will also remove the default close button, so please ensure you provide an easy, accessible way for users to dismiss the drawer.
|
|
24
23
|
- prop.dir: 'ltr'|'rtl'|'auto' — The element's directionality.
|
|
25
24
|
- prop.lang: string — The element's language.
|
|
@@ -42,13 +41,13 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
42
41
|
### CSS Parts
|
|
43
42
|
|
|
44
43
|
- part.base: The component's base wrapper.
|
|
45
|
-
- part.overlay: The overlay that covers the screen behind the drawer.
|
|
46
44
|
- part.panel: The drawer's panel (where the drawer and its content are rendered).
|
|
47
45
|
- part.header: The drawer's header. This element wraps the title and the close-button.
|
|
48
46
|
- part.title: The drawer's title.
|
|
49
47
|
- part.close-button: The close button, an `<sd-button>`.
|
|
50
48
|
- part.body: The drawer's body.
|
|
51
49
|
- part.footer: The drawer's footer.
|
|
50
|
+
- part.overlay: The overlay that covers the screen behind the drawer.
|
|
52
51
|
|
|
53
52
|
## Guidelines
|
|
54
53
|
|
|
@@ -8,11 +8,13 @@
|
|
|
8
8
|
|
|
9
9
|
Use the components tool by passing the args `component` and `example` for any of these combinations:
|
|
10
10
|
|
|
11
|
+
- component: sd-header, example: shadow
|
|
11
12
|
- component: sd-header, example: fixed
|
|
12
13
|
|
|
13
14
|
### Key Properties
|
|
14
15
|
|
|
15
|
-
- prop.fixed: boolean, default=false — Determines whether the header is fixed or not. If the header is fixed at the top of the page
|
|
16
|
+
- prop.fixed: boolean, default=false — Determines whether the header is fixed or not. If the header is fixed, it stays at the top of the page while scrolling.
|
|
17
|
+
- prop.shadow: boolean, default=false — Determines whether a drop shadow is shown underneath the header.
|
|
16
18
|
- prop.dir: 'ltr'|'rtl'|'auto' — The element's directionality.
|
|
17
19
|
- prop.lang: string — The element's language.
|
|
18
20
|
|
|
@@ -28,8 +30,8 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
28
30
|
|
|
29
31
|
### Use Cases
|
|
30
32
|
|
|
31
|
-
- Display primary navigation links for easy access to different sections of the website.
|
|
32
33
|
- Showcase the company logo prominently to reinforce brand identity.
|
|
34
|
+
- Display primary navigation links for easy access to different sections of the website.
|
|
33
35
|
- Include links for user account access.
|
|
34
36
|
- Provide a prominent search function to help users quickly find content.
|
|
35
37
|
|
|
@@ -16,7 +16,7 @@ Here's an example that registers an icon library located in the `/assets/icons`
|
|
|
16
16
|
If you use the IIFE bundle, you have to access the `registerIconLibrary()` function from the `SolidComponents` global.
|
|
17
17
|
|
|
18
18
|
```html
|
|
19
|
-
<script src="https://
|
|
19
|
+
<script src="https://your-cdn.example.com/components/%COMPONENTS-VERSION%/cdn/solid-components.iife.js"></script>
|
|
20
20
|
<script>
|
|
21
21
|
const { registerIconLibrary } = window['SolidComponents'];
|
|
22
22
|
registerIconLibrary('my-icons', {
|
|
@@ -65,6 +65,7 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
65
65
|
- prop.step: number|'any' — Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
|
|
66
66
|
implied, allowing any numeric value. Only applies to date and number input types.
|
|
67
67
|
- prop.autocapitalize: 'off'|'none'|'on'|'sentences'|'words'|'characters' — Controls whether and how text input is automatically capitalized as it is entered by the user.
|
|
68
|
+
- prop.autocorrect: boolean — Indicates whether the browser's autocorrect feature is on or off.
|
|
68
69
|
- prop.autocomplete: string — Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
|
|
69
70
|
[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
|
|
70
71
|
- prop.autofocus: boolean — Indicates that the input should receive focus on page load.
|
|
@@ -5,6 +5,11 @@ Use the `duration` attribute to set the duration (in milliseconds) of the notifi
|
|
|
5
5
|
<sd-notification id="duration-example" variant="info" open duration="5000">
|
|
6
6
|
Notification will self close after 5 seconds
|
|
7
7
|
</sd-notification>
|
|
8
|
+
<style>
|
|
9
|
+
sd-notification#duration-example::part(base) {
|
|
10
|
+
margin-top: 0.5rem;
|
|
11
|
+
}
|
|
12
|
+
</style>
|
|
8
13
|
<script>
|
|
9
14
|
var notificationDuration = document.querySelector('#duration-example');
|
|
10
15
|
notificationDuration.addEventListener('sd-after-hide', () => {
|
|
@@ -72,4 +72,4 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
72
72
|
|
|
73
73
|
### Interactivity
|
|
74
74
|
|
|
75
|
-
- Tags are interactive elements which trigger an action; to label or categorise items without any interaction use [sd-chip](./?path=/docs/styles-sd-chip--docs)
|
|
75
|
+
- Tags are interactive elements which trigger an action; to label or categorise items without any interaction use [sd-chip](./?path=/docs/styles-sd-chip--docs) instead.
|
|
@@ -44,7 +44,7 @@ Use the components tool by passing the args `component` and `example` for any of
|
|
|
44
44
|
- prop.minlength: number — The minimum length of input that will be considered valid.
|
|
45
45
|
- prop.maxlength: number — The maximum length of input that will be considered valid.
|
|
46
46
|
- prop.autocapitalize: 'off'|'none'|'on'|'sentences'|'words'|'characters' — Controls whether and how text input is automatically capitalized as it is entered by the user.
|
|
47
|
-
- prop.autocorrect:
|
|
47
|
+
- prop.autocorrect: boolean — Indicates whether the browser's autocorrect feature is on or off.
|
|
48
48
|
- prop.autocomplete: string — Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
|
|
49
49
|
[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
|
|
50
50
|
- prop.autofocus: boolean — Indicates that the input should receive focus on page load.
|
|
@@ -79,16 +79,16 @@
|
|
|
79
79
|
"displayNameDe": "Herz voll",
|
|
80
80
|
"tags": ["Favoriten", "gespeichert", "gemerkt"]
|
|
81
81
|
},
|
|
82
|
-
{
|
|
83
|
-
"technicalId": "flash-on",
|
|
84
|
-
"displayNameDe": "Blitz an",
|
|
85
|
-
"tags": ["Taschenlampe an", "Foto"]
|
|
86
|
-
},
|
|
87
82
|
{
|
|
88
83
|
"technicalId": "battery-full",
|
|
89
84
|
"displayNameDe": "Batterie voll\n",
|
|
90
85
|
"tags": ["voll", "Akku", "Ladestatus"]
|
|
91
86
|
},
|
|
87
|
+
{
|
|
88
|
+
"technicalId": "flash-on",
|
|
89
|
+
"displayNameDe": "Blitz an",
|
|
90
|
+
"tags": ["Taschenlampe an", "Foto"]
|
|
91
|
+
},
|
|
92
92
|
{
|
|
93
93
|
"technicalId": "sort-down",
|
|
94
94
|
"displayNameDe": "sortieren absteigend",
|
|
@@ -314,16 +314,16 @@
|
|
|
314
314
|
"displayNameDe": "einklappen unten",
|
|
315
315
|
"tags": ["verstecken", "komprimieren", "Seitenleiste"]
|
|
316
316
|
},
|
|
317
|
-
{
|
|
318
|
-
"technicalId": "bug",
|
|
319
|
-
"displayNameDe": "Fehler",
|
|
320
|
-
"tags": ["Mangel", "Problem"]
|
|
321
|
-
},
|
|
322
317
|
{
|
|
323
318
|
"technicalId": "shopping-cart",
|
|
324
319
|
"displayNameDe": "Einkaufswagen",
|
|
325
320
|
"tags": ["Onlineshop", "Warenkorb", "Erwerb", "Einkauf"]
|
|
326
321
|
},
|
|
322
|
+
{
|
|
323
|
+
"technicalId": "bug",
|
|
324
|
+
"displayNameDe": "Fehler",
|
|
325
|
+
"tags": ["Mangel", "Problem"]
|
|
326
|
+
},
|
|
327
327
|
{
|
|
328
328
|
"technicalId": "eraser",
|
|
329
329
|
"displayNameDe": "Radiergummi",
|
|
@@ -614,26 +614,26 @@
|
|
|
614
614
|
"displayNameDe": "Bildschirm Cursor",
|
|
615
615
|
"tags": ["klicken", "auswählen"]
|
|
616
616
|
},
|
|
617
|
-
{
|
|
618
|
-
"technicalId": "layers",
|
|
619
|
-
"displayNameDe": "Ebenen",
|
|
620
|
-
"tags": ["gruppieren", "Stapel", "mehrere Folien erzeugen"]
|
|
621
|
-
},
|
|
622
617
|
{
|
|
623
618
|
"technicalId": "file-read-out",
|
|
624
619
|
"displayNameDe": "Dokument vorlesen",
|
|
625
620
|
"tags": ["vorlesen", "Audio", "Lautstärke"]
|
|
626
621
|
},
|
|
627
622
|
{
|
|
628
|
-
"technicalId": "
|
|
629
|
-
"displayNameDe": "
|
|
630
|
-
"tags": ["
|
|
623
|
+
"technicalId": "layers",
|
|
624
|
+
"displayNameDe": "Ebenen",
|
|
625
|
+
"tags": ["gruppieren", "Stapel", "mehrere Folien erzeugen"]
|
|
631
626
|
},
|
|
632
627
|
{
|
|
633
628
|
"technicalId": "file-wai",
|
|
634
629
|
"displayNameDe": "Dokument wAI",
|
|
635
630
|
"tags": ["Dokument", "Datei", "wAI"]
|
|
636
631
|
},
|
|
632
|
+
{
|
|
633
|
+
"technicalId": "collapse-left",
|
|
634
|
+
"displayNameDe": "einklappen links",
|
|
635
|
+
"tags": ["komprimieren", "verstecken", "Seitenleiste"]
|
|
636
|
+
},
|
|
637
637
|
{
|
|
638
638
|
"technicalId": "download",
|
|
639
639
|
"displayNameDe": "Download",
|
|
@@ -1044,16 +1044,16 @@
|
|
|
1044
1044
|
"displayNameDe": "antworten",
|
|
1045
1045
|
"tags": ["Rückmeldung", "Nachricht", "Kommunikation"]
|
|
1046
1046
|
},
|
|
1047
|
-
{
|
|
1048
|
-
"technicalId": "password",
|
|
1049
|
-
"displayNameDe": "Passwort",
|
|
1050
|
-
"tags": ["sicherheitsgeschützt", "privat", "verschlüsselt"]
|
|
1051
|
-
},
|
|
1052
1047
|
{
|
|
1053
1048
|
"technicalId": "e-mail-send",
|
|
1054
1049
|
"displayNameDe": "E-Mail abschicken",
|
|
1055
1050
|
"tags": ["Brief", "E-Mail", "Kommunikation"]
|
|
1056
1051
|
},
|
|
1052
|
+
{
|
|
1053
|
+
"technicalId": "password",
|
|
1054
|
+
"displayNameDe": "Passwort",
|
|
1055
|
+
"tags": ["sicherheitsgeschützt", "privat", "verschlüsselt"]
|
|
1056
|
+
},
|
|
1057
1057
|
{
|
|
1058
1058
|
"technicalId": "e-mail-exclamation",
|
|
1059
1059
|
"displayNameDe": "E-Mail Ausrufezeichen",
|
|
@@ -6,33 +6,15 @@ To develop with Solid Design System, you need the following three packages:
|
|
|
6
6
|
- `@solid-design-system/styles`: Smaller components built with CSS.
|
|
7
7
|
- `@solid-design-system/tokens`: Tokens and themes for consistent design.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
```js
|
|
20
|
-
import '@solid-design-system/tokens/dist/themes/ui-light/ui-light.css';
|
|
21
|
-
import '@solid-design-system/styles/dist/solid-styles.css';
|
|
22
|
-
import '@solid-design-system/components/dist/solid-components.css';
|
|
23
|
-
import '@solid-design-system/components/dist/solid-components.js';
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
</sd-tab-panel>
|
|
27
|
-
<sd-tab-panel name="cdn">
|
|
28
|
-
```html
|
|
29
|
-
<link rel="stylesheet" href="https://solid-design-system.fe.union-investment.de/tokens/%TOKENS-VERSION%/cdn/themes/ui-light/ui-light.css" />
|
|
30
|
-
<link rel="stylesheet" href="https://solid-design-system.fe.union-investment.de/styles/%STYLES-VERSION%/cdn/solid-styles.css" />
|
|
31
|
-
<link rel="stylesheet" href="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.css" />
|
|
32
|
-
<script type="module" src="https://solid-design-system.fe.union-investment.de/components/%COMPONENTS-VERSION%/cdn/solid-components.js"></script>
|
|
33
|
-
```
|
|
34
|
-
</sd-tab-panel>
|
|
35
|
-
</sd-tab-group>
|
|
9
|
+
```bash
|
|
10
|
+
pnpm i @solid-design-system/components @solid-design-system/styles @solid-design-system/tokens
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
For environments without a bundler (e.g. a CMS), see [CDN Hosting](?path=/docs/docs-general-cdn-hosting--docs).
|
|
36
18
|
|
|
37
19
|
Now you are ready to use Solid Design System in your project!
|
|
38
20
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Installation
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Solid Styles is installed via npm. For environments without a bundler, see [CDN Hosting](?path=/docs/docs-general-cdn-hosting--docs).
|
|
4
4
|
|
|
5
|
-
<sd-notification
|
|
5
|
+
<sd-notification variant="info" open id="versioning-info">
|
|
6
6
|
The `components`, `styles`, and `tokens` packages now always share the same version. We use fixed versioning to keep
|
|
7
7
|
them fully in sync, so every release updates all three packages, even if only one of them changed. Make sure to
|
|
8
8
|
install or update them using the same version number.
|
|
@@ -37,38 +37,9 @@ Including version numbers in component names provides more control over updates
|
|
|
37
37
|
</sd-tab-panel>
|
|
38
38
|
</sd-tab-group>
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Installation
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
The CDN Bundle registers all Solid elements up front. Note that, if you're only using a handful of components, it could be more efficient [cherry pick](#cherry-picking) components if you want to load specific ones up front.
|
|
45
|
-
|
|
46
|
-
<sd-tab-group>
|
|
47
|
-
{/* prettier-ignore */}
|
|
48
|
-
<sd-tab slot="nav" panel="unversioned">Unversioned</sd-tab>
|
|
49
|
-
{/* prettier-ignore */}
|
|
50
|
-
<sd-tab slot="nav" panel="versioned">Versioned</sd-tab>
|
|
51
|
-
<sd-tab-panel name="unversioned">
|
|
52
|
-
```html
|
|
53
|
-
<link
|
|
54
|
-
rel="stylesheet"
|
|
55
|
-
href="https://solid-design-system.fe.union-investment.de/styles/%STYLES-VERSION%/cdn/solid-styles.css"
|
|
56
|
-
/>
|
|
57
|
-
```
|
|
58
|
-
</sd-tab-panel>
|
|
59
|
-
<sd-tab-panel name="versioned">
|
|
60
|
-
```html
|
|
61
|
-
<link
|
|
62
|
-
rel="stylesheet"
|
|
63
|
-
href="https://solid-design-system.fe.union-investment.de/styles/%STYLES-VERSION%/cdn-versioned/solid-styles.css"
|
|
64
|
-
/>
|
|
65
|
-
```
|
|
66
|
-
</sd-tab-panel>
|
|
67
|
-
</sd-tab-group>
|
|
68
|
-
|
|
69
|
-
## npm installation
|
|
70
|
-
|
|
71
|
-
If you don't want to use the CDN, you can install Solid Styles from npm with the following command.
|
|
42
|
+
Install Solid Styles from npm:
|
|
72
43
|
|
|
73
44
|
```bash
|
|
74
45
|
npm install @solid-design-system/styles
|
|
@@ -99,7 +70,7 @@ Alternatively, you can use a bundler.
|
|
|
99
70
|
|
|
100
71
|
## Cherry Picking
|
|
101
72
|
|
|
102
|
-
Cherry picking
|
|
73
|
+
Cherry picking loads only the styles you need up front, limiting the number of files the browser has to download. The disadvantage is that you need to import each individual style.
|
|
103
74
|
|
|
104
75
|
Here's an example that loads only the mark style that would work in Vite.
|
|
105
76
|
|
|
@@ -135,27 +106,8 @@ Here's an example that loads only the mark style that would work in Vite.
|
|
|
135
106
|
|
|
136
107
|
tbd.
|
|
137
108
|
|
|
138
|
-
##
|
|
139
|
-
|
|
140
|
-
CDN links all start with `/cdn/<path>` and npm imports use `/dist/<path>`. The `/cdn` files are already minified, while `npm` can be easily patched.
|
|
141
|
-
|
|
142
|
-
TL;DR:
|
|
143
|
-
|
|
144
|
-
<sd-tab-group>
|
|
145
|
-
{/* prettier-ignore */}
|
|
146
|
-
<sd-tab slot="nav" panel="unversioned">Unversioned</sd-tab>
|
|
147
|
-
{/* prettier-ignore */}
|
|
148
|
-
<sd-tab slot="nav" panel="versioned">Versioned</sd-tab>
|
|
149
|
-
<sd-tab-panel name="unversioned">
|
|
150
|
-
|
|
151
|
-
- `@solid-design-system/styles/cdn` is for CDN users
|
|
152
|
-
- `@solid-design-system/styles/dist` is for npm users
|
|
153
|
-
|
|
154
|
-
</sd-tab-panel>
|
|
155
|
-
<sd-tab-panel name="versioned">
|
|
109
|
+
## cdn/ vs dist/
|
|
156
110
|
|
|
157
|
-
|
|
158
|
-
- `@solid-design-system/styles/dist-versioned` is for npm users
|
|
111
|
+
The package ships both `cdn/` and `dist/` artifacts. The `/cdn` files are already minified. The `/dist` files can be more easily patched and are better suited for bundlers.
|
|
159
112
|
|
|
160
|
-
|
|
161
|
-
</sd-tab-group>
|
|
113
|
+
Use `/dist` with a bundler (recommended). Use `/cdn` only when hosting on your own CDN without build tooling — see [CDN Hosting](?path=/docs/general-cdn-hosting--docs).
|