You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`@spectrum-web-components/bundle` is a master dependency that allows a project to import any and all of the Spectrum Web Components. While it is a great approach to prototyping, the fact that is versions all of the Spectrum Web Components packages collectively means that depending on it can leave you with a lot of package updates to manage at any one version change. For a more predictable upgrade process we suggest that you depend upon individual packages directly, but hope you find this bundle productive when initially trying to get into the act of developing with Spectrum Web Components!
3
+
`@spectrum-web-components/bundle` is a master dependency that allows a project to import any and all of the Spectrum Web Components. While it is a great approach to prototyping, the fact that it versions all of the Spectrum Web Components packages collectively means that depending on it can leave you with a lot of package updates to manage at any one version change. For a more predictable upgrade process we suggest that you depend upon individual packages directly, but hope you find this bundle productive when initially trying to get into the act of developing with Spectrum Web Components.
4
4
5
5
### Usage
6
6
7
7
[](https://www.npmjs.com/package/@spectrum-web-components/bundle)
8
8
[](https://bundlephobia.com/result?p=@spectrum-web-components/bundle)
9
9
10
-
```
10
+
```bash
11
11
yarn add @spectrum-web-components/bundle
12
12
```
13
13
14
14
Import the side effectful registrations of the bundled components:
When looking to leverage their base classes as a type and/or for extension purposes, do so via something like the following for the `ActionButton` base class:
- All Spectrum Web Component elements registrations
31
+
- Base classes for all components available for type checking and extension
32
+
- Namespaced icon exports for UI and workflow icons (e.g., `UIIcons`, `WorkflowIcons`)
33
+
34
+
### Options
27
35
28
-
While this bundle directly re-exports the majority of functionality as they would be exported from their own packages, icon packages that export template literals are handled a little different. Due to the large number of exports that they feature, each of these packages are namespaced when included in the bundle.
36
+
#### Component Registration
29
37
30
-
#### UI
38
+
Import all component registrations at once for rapid prototyping:
31
39
32
-
`@spectrum-web-components/icons-ui` is renamed to `UIIcons` when leveraging the bundle. This means that you can use workflow icons in your demonstration code by importing them from `@spectrum-web-components/bundle/icons.js` like the following:
While this bundle directly re-exports the majority of functionality as they would be exported from their own packages, icon packages that export template literals are handled differently. Due to the large number of exports that they feature, each of these packages is namespaced when included in the bundle.
59
+
60
+
##### UI Icons
61
+
62
+
`@spectrum-web-components/icons-ui` is renamed to `UIIcons` when leveraging the bundle. This means that you can use UI icons in your code by importing them from `@spectrum-web-components/bundle/icons.js`:
`@spectrum-web-components/icons-workflow` is namespaced to `WorkflowIcons` when leveraging the bundle. This means that you can use workflow icons in your demonstration code by importing them from `@spectrum-web-components/bundle/icons.js` like the following:
76
+
`@spectrum-web-components/icons-workflow` is namespaced to `WorkflowIcons` when leveraging the bundle. This means that you can use workflow icons in your code by importing them from `@spectrum-web-components/bundle/icons.js`:
47
77
48
-
```
49
-
import { IconsWorkflow } from '@spectrum-web-components/bundle/icons.js';
The bundle versions all Spectrum Web Components packages collectively. This means:
91
+
92
+
- A single version bump updates all components simultaneously
93
+
- You may receive updates for components you're not actively using
94
+
- For production applications, consider depending on individual packages for more granular control
95
+
96
+
### Accessibility
97
+
98
+
All components included in the bundle follow WCAG accessibility guidelines. Each component maintains its own accessibility features as documented in their individual package documentation. Refer to the specific component documentation pages for detailed accessibility information.
0 commit comments