https://github.com/carbon-design-system/carbon-icons-svelte
Carbon Design System SVG icons as Svelte components
https://github.com/carbon-design-system/carbon-icons-svelte
carbon carbon-design-system components ibm icons svelte svelte-components svg svg-icons typescript-definitions
Last synced: about 1 month ago
JSON representation
Carbon Design System SVG icons as Svelte components
- Host: GitHub
- URL: https://github.com/carbon-design-system/carbon-icons-svelte
- Owner: carbon-design-system
- License: apache-2.0
- Created: 2019-12-13T17:50:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T16:32:28.000Z (9 months ago)
- Last Synced: 2024-08-01T12:43:58.116Z (9 months ago)
- Topics: carbon, carbon-design-system, components, ibm, icons, svelte, svelte-components, svg, svg-icons, typescript-definitions
- Language: TypeScript
- Homepage: https://carbon-icons-svelte.onrender.com
- Size: 7.54 MB
- Stars: 393
- Watchers: 11
- Forks: 22
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred - carbon-design-system/carbon-icons-svelte - Carbon Design System SVG icons as Svelte components (svelte)
README
# carbon-icons-svelte
[![NPM][npm]][npm-url]
> [Carbon Design System](https://github.com/carbon-design-system) SVG icons as Svelte components.
This zero dependency icon library builds [Carbon Design System icons](https://www.carbondesignsystem.com/elements/icons/library) as Svelte components. Although best paired with [carbon-components-svelte](https://github.com/IBM/carbon-components-svelte), these icons can be consumed standalone.
Try it in the [Svelte REPL](https://svelte.dev/repl/931e6a3461434622adad0557579c0a29).
## [Preview](https://carbon-icons-svelte.onrender.com) · [Icon Index](ICON_INDEX.md)
## Installation
```sh
# npm
npm i carbon-icons-svelte
# pnpm
pnpm i carbon-icons-svelte
# Yarn
yarn add carbon-icons-svelte
# Bun
bun add carbon-icons-svelte
```
## Usage
### Direct Import
Import the icon from the `carbon-icons-svelte/lib` folder. See the [Icon Index](ICON_INDEX.md) for a list of supported icons.
```svelte
import Add from "carbon-icons-svelte/lib/Add.svelte";
```
### Base Import with Preprocessor
> [!TIP]
> Use [optimizeImports](https://github.com/carbon-design-system/carbon-preprocess-svelte#optimizeimports) from [carbon-preprocess-svelte](https://github.com/carbon-design-system/carbon-preprocess-svelte) to speed up development times.
Due to the size of the library, importing directly from the barrel file may result in slow development times, since the entire barrel file is imported (thousands of icons).
[optimizeImports](https://github.com/carbon-design-system/carbon-preprocess-svelte#optimizeimports) is a Svelte preprocessor that optimizes import paths from Carbon Svelte libraries. It enables you to use the barrel file import syntax without importing the entire library.
For example, the following is automatically re-written by `optimizeImports`:
```diff
- import { Add } from "carbon-icons-svelte";
+ import Add from "carbon-icons-svelte/lib/Add.svelte";
```
This offers the best of both worlds:
- Concise import syntax
- Fast development times (only the icons you need are imported)
### Custom size
Use the `size` prop to specify the icon size.
Supported icon sizes include `16`, `20`, `24`, and `32`.
The default size is `16`.
```svelte
```
## API
All props are optional.
| Name | Type | Default value |
| :---- | :-------------------------------------------- | :------------ |
| size | 16 | 20 | 24 | 32 | `16` |
| title | `string` | `undefined` |
### Custom props
`$$restProps` are forwarded to the `svg` element.
You can use `fill` to customize the color or pass any other valid `svg` attribute to the component.
```svelte
```
### Labelled
```svelte
```
### Labelled by
```svelte
Add file
```
### Focusable
```svelte
```
## TypeScript
This library offers TypeScript support for Svelte 4 and Svelte 5.
For Svelte 3 compatibility, use [`[email protected]`](https://github.com/carbon-design-system/carbon-icons-svelte/tree/v12.13.0).
For convenience, a `CarbonIconProps` type is exported from the library.
```svelte
import Add from "carbon-icons-svelte/lib/Add.svelte";
import type { CarbonIconProps } from "carbon-icons-svelte";
const props: CarbonIconProps = {
size: 16,
fill: "red",
"data-test": "id",
};
```
## [Changelog](CHANGELOG.md)
## [Contributing](CONTRIBUTING.md)
## License
[Apache 2.0](LICENSE)
[npm]: https://img.shields.io/npm/v/carbon-icons-svelte.svg?color=262626&style=for-the-badge
[npm-url]: https://npmjs.com/package/carbon-icons-svelte