Convert Figma logo to code with AI

carbon-design-system logocarbon-components-svelte

Svelte implementation of the Carbon Design System

2,674
260
2,674
225
View on GitHubView on NPM

Top Related Projects

sveltejs's avatar

svelte

78,194

Cybernetically enhanced web apps

carbon-design-system's avatar

carbon-components-react

1,080

React components for the Carbon Design System

tailwindlabs's avatar

tailwindcss

81,795

A utility-first CSS framework for rapid UI development.

vuetifyjs's avatar

vuetify

39,623

🐉 Vue Component Framework

Quick Overview

Carbon Components Svelte is a Svelte implementation of the Carbon Design System, providing a set of reusable UI components for building web applications. It offers a comprehensive suite of components that adhere to IBM's design guidelines, ensuring consistency and accessibility across projects.

Pros

  • Seamless integration with Svelte projects
  • Comprehensive set of UI components following IBM's Carbon Design System
  • Excellent TypeScript support and type definitions
  • Regular updates and active community support

Cons

  • Limited customization options compared to vanilla CSS implementations
  • Learning curve for developers unfamiliar with Carbon Design System
  • Potential performance overhead for smaller projects that don't need all components

Code Examples

Creating a button:

<script>
  import { Button } from "carbon-components-svelte";
</script>

<Button>Click me</Button>

Using a data table:

<script>
  import { DataTable } from "carbon-components-svelte";
  
  let rows = [
    { id: 1, name: "Alice", age: 30 },
    { id: 2, name: "Bob", age: 25 },
  ];
</script>

<DataTable
  headers={[
    { key: "name", value: "Name" },
    { key: "age", value: "Age" },
  ]}
  {rows}
/>

Implementing a modal:

<script>
  import { Modal, Button } from "carbon-components-svelte";
  let open = false;
</script>

<Button on:click={() => (open = true)}>Open Modal</Button>

<Modal
  bind:open
  modalHeading="Example Modal"
  primaryButtonText="Confirm"
  secondaryButtonText="Cancel"
  on:click:button--secondary={() => (open = false)}
  on:submit={() => {
    // Handle form submission
    open = false;
  }}
>
  <p>Modal content goes here.</p>
</Modal>

Getting Started

  1. Install the package:

    npm install carbon-components-svelte

  2. Import and use components in your Svelte file:

    <script>
import { Button, TextInput } from "carbon-components-svelte";
</script>

<TextInput labelText="Name" placeholder="Enter your name" />
<Button>Submit</Button>

  3. (Optional) Include Carbon styles in your project's entry point:

    import "carbon-components-svelte/css/all.css";

Competitor Comparisons

sveltejs logo

svelte

78,194

Cybernetically enhanced web apps

Pros of Svelte

  • More lightweight and faster compilation compared to Carbon Components Svelte
  • Greater flexibility and customization options for building user interfaces
  • Larger community and ecosystem, with more resources and third-party libraries available

Cons of Svelte

  • Lacks pre-built UI components specific to IBM's Carbon Design System
  • May require more time to implement complex UI patterns that are already available in Carbon Components Svelte
  • Less opinionated, which can lead to inconsistencies in design and implementation across projects

Code Comparison

Svelte component:

<script>
  export let name = 'World';
</script>

<h1>Hello {name}!</h1>

Carbon Components Svelte component:

<script>
  import { Button } from "carbon-components-svelte";
</script>

<Button>Click me</Button>

The Svelte example shows a basic component with a customizable prop, while the Carbon Components Svelte example demonstrates the use of a pre-built UI component from the Carbon Design System. Carbon Components Svelte provides ready-to-use components that adhere to IBM's design guidelines, while Svelte offers more flexibility but requires manual implementation of UI elements.

carbon-design-system logo

carbon-components-react

1,080

React components for the Carbon Design System

Pros of carbon-components-react

  • Larger community and ecosystem, with more resources and third-party integrations
  • More mature and stable, with a longer development history
  • Extensive documentation and examples available

Cons of carbon-components-react

  • Larger bundle size due to React's overhead
  • Potentially slower performance compared to Svelte's compiled output
  • More complex setup and configuration required

Code Comparison

carbon-components-react:

import { Button } from 'carbon-components-react';

function MyComponent() {
  return <Button>Click me</Button>;
}

carbon-components-svelte:

<script>
  import { Button } from "carbon-components-svelte";
</script>

<Button>Click me</Button>

The Svelte version is more concise and doesn't require a separate function component. It also has a smaller runtime footprint due to Svelte's compilation process.

Both libraries provide Carbon Design System components for their respective frameworks, offering a consistent look and feel. carbon-components-react benefits from React's widespread adoption and extensive ecosystem, while carbon-components-svelte leverages Svelte's simplicity and performance optimizations. The choice between them depends on your project's specific requirements, team expertise, and performance considerations.

tailwindlabs logo

tailwindcss

81,795

A utility-first CSS framework for rapid UI development.

Pros of Tailwind CSS

  • Highly customizable and flexible, allowing for rapid UI development
  • Utility-first approach enables quick styling without leaving HTML
  • Large and active community, with extensive documentation and resources

Cons of Tailwind CSS

  • Steeper learning curve for developers new to utility-first CSS
  • Can lead to longer class strings in HTML, potentially reducing readability
  • Requires additional setup and configuration for optimal use

Code Comparison

Carbon Components Svelte:

<Button>Click me</Button>

Tailwind CSS:

<button class="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded">
  Click me
</button>

Carbon Components Svelte provides pre-built, styled components that are ready to use out of the box, while Tailwind CSS requires composing utility classes to achieve the desired styling. The Carbon approach results in cleaner HTML but less flexibility, whereas Tailwind offers more customization at the cost of verbose class names.

Both libraries have their strengths and are suited for different project needs. Carbon Components Svelte is ideal for rapid development with a consistent design system, while Tailwind CSS shines in projects requiring high customization and flexibility.

vuetifyjs logo

vuetify

39,623

🐉 Vue Component Framework

Pros of Vuetify

  • Larger ecosystem with more components and plugins
  • Extensive documentation and community support
  • Material Design-based, offering a familiar and modern look

Cons of Vuetify

  • Heavier bundle size, potentially impacting performance
  • Less flexibility in customization compared to Carbon Components Svelte
  • Steeper learning curve due to its comprehensive nature

Code Comparison

Carbon Components Svelte:

<script>
  import { Button } from "carbon-components-svelte";
</script>

<Button>Click me</Button>

Vuetify:

<template>
  <v-btn>Click me</v-btn>
</template>

<script>
import { defineComponent } from 'vue'

export default defineComponent({
  // Component logic here
})
</script>

Carbon Components Svelte offers a more straightforward implementation, while Vuetify requires a bit more boilerplate code. However, Vuetify provides more built-in styling options and features out of the box.

Both libraries aim to simplify UI development, but Carbon Components Svelte focuses on IBM's Carbon Design System, while Vuetify adheres to Material Design principles. The choice between them depends on project requirements, design preferences, and the desired level of customization.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

carbon-components-svelte

NPM GitHub npm downloads to date Chat with us on Discord

Carbon Components Svelte is a Svelte component library that implements the 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:

Documentation

Other forms of documentation are auto-generated:

Installation

Install carbon-components-svelte as a development dependency.

# 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

Each StyleSheet is generated from the flagship carbon-components library.

The compiled CSS is generated from the following .scss files:

CSS StyleSheet

// 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";

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 for documentation.

Dynamic theming

Use the "all.css" StyleSheet for dynamic, client-side theming.

import "carbon-components-svelte/css/all.css";

Update the theme by setting the theme attribute on the html element. The default theme is "white".

<!DOCTYPE html>
<html lang="en" theme="g10">
  <body>
    ...
  </body>
</html>

Programmatically switch between each of the five Carbon themes by setting the "theme" attribute on the HTML element.

<script>
  let theme = "white"; // "white" | "g10" | "g80" | "g90" | "g100"

  $: document.documentElement.setAttribute("theme", theme);
</script>

Importing components

Import components from carbon-components-svelte in the script tag of your Svelte file. Visit the documentation site for examples.

<!-- App.svelte -->
<script>
  import { Accordion, AccordionItem } from "carbon-components-svelte";
</script>

<Accordion>
  <AccordionItem title="Section 1" open> Content 1 </AccordionItem>
  <AccordionItem title="Section 2"> Content 2 </AccordionItem>
  <AccordionItem title="Section 3"> Content 3 </AccordionItem>
</Accordion>

Refer to COMPONENT_INDEX.md for component API documentation.

Preprocessors & Plugins

carbon-preprocess-svelte is a collection of Svelte preprocessors for Carbon.

[!NOTE] Using carbon-preprocess-svelte is optional and not a prerequisite for this library.

# 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 Svelte preprocessor that rewrites barrel imports from Carbon components/icons/pictograms packages to their source Svelte code paths. This can significantly speed up development and production build compile times while preserving typeahead and autocompletion offered by integrated development environments (IDE) like VS Code.

The preprocessor optimizes imports from the following packages:

Before & After

- import { Button } from "carbon-components-svelte";
+ import Button from "carbon-components-svelte/src/Button/Button.svelte";

- import { Add } from "carbon-icons-svelte";
+ import Add from "carbon-icons-svelte/lib/Add.svelte";

- import { Airplane } from "carbon-pictograms-svelte";
+ import Airplane from "carbon-pictograms-svelte/lib/Airplane.svelte";

Usage

See examples for full configurations.

// svelte.config.js
import { optimizeImports } from "carbon-preprocess-svelte";

export default {
  preprocess: [optimizeImports()],
};

Any other preprocessors that transpile code in the script block should be invoked before optimizeImports.

For example, vitePreprocess should precede optimizeImports.

// svelte.config.js
+ import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
import { optimizeImports } from "carbon-preprocess-svelte";

export default {
  preprocess: [
+   vitePreprocess(),
    optimizeImports()
  ],
};

optimizeCss

optimizeCss is a Vite plugin that removes unused Carbon styles at build time. The plugin is compatible with Rollup (Vite extends the Rollup plugin API).

carbon-components-svelte@0.85.0 or greater is required.

$ vite build

Optimized index-CU4gbKFa.css
- Before: 606.26 kB
+ After:   53.22 kB (-91.22%)

dist/index.html                  0.34 kB │ gzip:  0.24 kB
dist/assets/index-CU4gbKFa.css  53.22 kB │ gzip:  6.91 kB
dist/assets/index-Ceijs3eO.js   53.65 kB │ gzip: 15.88 kB

[!NOTE] This is a plugin and not a Svelte preprocessor. It should be added to the list of vite.plugins. For Vite set-ups, this plugin is only run when building the app. For Rollup and Webpack, you should conditionally apply the plugin to only execute when building for production.

Usage

See examples for full configurations.

// vite.config.js
import { sveltekit } from "@sveltejs/kit/vite";
import { optimizeCss } from "carbon-preprocess-svelte";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [sveltekit(), optimizeCss()],
});

Examples

TypeScript support

TypeScript definitions are generated by sveld.

Contributing

Refer to the Contributing guidelines.

Changelog

License

Apache 2.0

IBM Telemetry 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. For more information on the data being collected, please see the IBM Telemetry documentation.

NPM DownloadsLast 30 Days