# carbon-components-svelte [![NPM][npm]][npm-url] ![GitHub](https://img.shields.io/github/license/carbon-design-system/carbon-components-svelte?color=262626&style=for-the-badge) ![npm downloads to date](https://img.shields.io/npm/dt/carbon-components-svelte?color=262626&style=for-the-badge)

Carbon Components Svelte is a [Svelte](https://github.com/sveltejs/svelte) component library that implements the [Carbon Design System](https://github.com/carbon-design-system), an open source design system by IBM. Design systems facilitate design and development through reuse, consistency, and extensibility. The Carbon Svelte portfolio also includes: - **[Carbon Icons Svelte](https://github.com/carbon-design-system/carbon-icons-svelte)**: 2,200+ Carbon icons as Svelte components - **[Carbon Pictograms Svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte)**: 1,100+ Carbon pictograms as Svelte components - **[Carbon Charts Svelte](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/svelte)**: 20+ charts, powered by d3 - **[Carbon Preprocess Svelte](https://github.com/carbon-design-system/carbon-preprocess-svelte)**: Collection of Svelte preprocessors for Carbon ## [Documentation](https://svelte.carbondesignsystem.com) Other forms of documentation are auto-generated: - **[TypeScript definitions](types)**: Component TypeScript definitions - **[Component Index](COMPONENT_INDEX.md)**: Component API in Markdown format - **[Component API](docs/src/COMPONENT_API.json)**: Component API in JSON format ## Installation Install `carbon-components-svelte` as a development dependency. ```sh # Yarn yarn add -D carbon-components-svelte # npm npm i -D carbon-components-svelte # pnpm pnpm i -D carbon-components-svelte ``` ## Usage ### Styling Before importing components, you will need to first apply Carbon component styles. The Carbon Design System supports five themes (2 light, 3 dark). - **white.css**: Default Carbon theme (light) - **g10.css**: Gray 10 theme (light) - **g80.css**: Gray 80 theme (dark) - **g90.css**: Gray 90 theme (dark) - **g100.css**: Gray 100 theme (dark) - **all.css**: All themes (White, Gray 10, Gray 90, Gray 100) using [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) Each StyleSheet is [generated](scripts/build-css.js) from the flagship [carbon-components](https://github.com/carbon-design-system/carbon/tree/main/packages/carbon-components) library. The compiled CSS is generated from the following `.scss` files: - [css/white.scss](css/white.scss) - [css/g10.scss](css/g10.scss) - [css/g80.scss](css/g80.scss) - [css/g90.scss](css/g90.scss) - [css/g100.scss](css/g100.scss) - [css/all.scss](css/all.scss) #### CSS StyleSheet ```js // White theme import "carbon-components-svelte/css/white.css"; // Gray 10 theme import "carbon-components-svelte/css/g10.css"; // Gray 80 theme import "carbon-components-svelte/css/g80.css"; // Gray 90 theme import "carbon-components-svelte/css/g90.css"; // Gray 100 theme import "carbon-components-svelte/css/g100.css"; // All themes import "carbon-components-svelte/css/all.css"; ``` #### CDN An alternative to loading styles is to link an external StyleSheet from a Content Delivery Network (CDN) like [unpkg.com](https://unpkg.com/). This is best suited for rapid prototyping. ##### HTML ```html ``` ##### `svelte:head` ```html ``` ### SCSS The most performant method to load styles is to import SCSS directly from carbon-components. Although it requires more set up, you can reduce the size of the bundle CSS by importing individual component styles instead of a pre-compiled CSS StyleSheet. Refer to the [official Carbon guide on SASS](https://github.com/carbon-design-system/carbon/blob/v10/docs/guides/sass.md) for documentation. ### Dynamic theming Use the "all.css" StyleSheet for dynamic, client-side theming. ```js import "carbon-components-svelte/css/all.css"; ``` Update the theme by setting the `theme` attribute on the `html` element. The default `theme` is `"white"`. ```html ... ``` Programmatically switch between each of the five Carbon themes by setting the "theme" attribute on the HTML element. ```html ``` ### Importing components Import components from `carbon-components-svelte` in the `script` tag of your Svelte file. Visit the [documentation site](https://svelte.carbondesignsystem.com) for examples. ```html Content 1 Content 2 Content 3 ``` **Refer to [COMPONENT_INDEX.md](COMPONENT_INDEX.md) for component API documentation.** ## Preprocessors [carbon-preprocess-svelte](https://github.com/carbon-design-system/carbon-preprocess-svelte) is a collection of Svelte preprocessors for Carbon. ```sh # Yarn yarn add -D carbon-preprocess-svelte # npm npm i -D carbon-preprocess-svelte # pnpm pnpm i -D carbon-preprocess-svelte ``` ### `optimizeImports` `optimizeImports` is a script preprocessor that rewrites base imports from Carbon components/icons/pictograms packages to their source Svelte code paths. This can greatly speed up compile times during development while preserving typeahead and autocompletion hinting offered by integrated development environments (IDE) like VSCode. The preprocessor optimizes imports from the following packages: - [carbon-components-svelte](https://github.com/carbon-design-system/carbon-components-svelte) - [carbon-icons-svelte](https://github.com/carbon-design-system/carbon-icons-svelte) - [carbon-pictograms-svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte) **Before & After** ```diff - import { Button } from "carbon-components-svelte"; - import { Add16 } from "carbon-icons-svelte"; - import { Airplane } from "carbon-pictograms-svelte"; + import Button from "carbon-components-svelte/src/Button/Button.svelte"; + import Add16 from "carbon-icons-svelte/lib/Add16.svelte"; + import Airplane from "carbon-pictograms-svelte/lib/Airplane.svelte"; ``` #### Usage ```js // svelte.config.js import { optimizeImports } from "carbon-preprocess-svelte"; export default { preprocess: [optimizeImports()], }; ``` `svelte-preprocess` should be invoked before any preprocessor from `carbon-preprocess-svelte`. ```diff // svelte.config.js + import sveltePreprocess from "svelte-preprocess"; import { optimizeImports } from "carbon-preprocess-svelte"; export default { preprocess: [ + sveltePreprocess(), optimizeImports() ], }; ``` ## Examples - [examples/rollup](examples/rollup/) - [examples/sveltekit](examples/sveltekit/) - [examples/vite](examples/vite/) - [examples/webpack](examples/webpack/) ## TypeScript support [TypeScript definitions](types) are generated by [sveld](https://github.com/carbon-design-system/sveld). ## Contributing Refer to the [Contributing guidelines](CONTRIBUTING.md). ## [Changelog](CHANGELOG.md) ## License [Apache 2.0](LICENSE) [npm]: https://img.shields.io/npm/v/carbon-components-svelte.svg?color=262626&style=for-the-badge [npm-url]: https://npmjs.com/package/carbon-components-svelte ##

IBM Telemetry This package uses IBM Telemetry to collect anonymous metrics data in CI environments. By installing this package as a dependency you are agreeing to telemetry collection. To opt out, see [Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). For more information on the data being collected, please see the [IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).

	Stars	Issues	Version	Updated	Created
carbon-components-svelte	2,600	224	0.85.0	25 days ago	4 years ago
svelte-material-ui			7.0.0-beta.18	a month ago	5 years ago
svelte-materialify	623	63	0.3.11	3 years ago	4 years ago

carbon-components-svelte vs svelte-material-ui vs svelte-materialify

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past