Giter VIP home page Giter VIP logo

continuum's Introduction

cds-design

A component library for CDS (Continuum Design System) by Verve.

npm MIT license npm GitHub top language GitHub commit activity (branch) Types Included


๐Ÿš€ Features

  • ๐Ÿชถ Lightweight: The library is very lightweight, that it costs around 5KB plus 2KB per component in your bundle.
  • โš™๏ธ Framework Agnostic: The library is framework agnostic and can be used with any framework or even vanilla HTML.
  • ๐Ÿ”ง Customizable: The library is highly customizable and you can customize the components to your needs.
  • โ™ฟ๏ธ Accessible: The library is accessible and follows the WAI-ARIA guidelines.
  • ๐Ÿ”ฅ Performant: The library is performant by utilizing Web Components and employing Lazy loading, Tree-Shaking, and many more technologies under the hood.
  • ๐Ÿ’ป Cross-Browser: The library is build on browser native technologies and works on all modern browsers.
  • ๐Ÿ‘จโ€๐Ÿ’ป DX: The library is build with developer experience in mind and provides a great developer experience. All components are typed and provide great intellisense support.

โฌ‡๏ธ Installation

npm install cds-design

or

yarn add cds-design

or

pnpm add cds-design

๐Ÿ“ฆ Usage

After installing you can directly use the components in your project.

Vanilla HTML

<script type="module">
    import { load } from "https://esm.run/cds-design" // or import load from "https://esm.run/cds-design"
    load("button", "input", "checkbox")
</script>

<cds-button>Click Me</cds-button>

React (JSX)

import { load } from "cds-design" // or import load from "cds-design"
load("button", "input", "checkbox")

export default () => {
  return (
    <cds-button>Click Me</cds-button>
  )
}

Vue (Composition API)

<script setup lang="ts">
    import { load } from "cds-design" // or import load from "cds-design"
    load("button", "input", "checkbox")
</script>

<template>
    <cds-button>Click Me</cds-button>
</template>

Svelte

<script context="module">
    import { load } from "cds-design" // or import load from "cds-design"
    load("button", "input", "checkbox")
</script>

<cds-button>Click Me</cds-button>

๐Ÿ“š Documentation

You can find the detailed documentation here.

๐Ÿ“ License

This project is licensed under the MIT License.

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page

๐Ÿ’ช Show your support

Give a โญ๏ธ if this project helped you!

๐Ÿค Contributors

continuum's People

Contributors

rajaniraiyn avatar teejaswan avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.