Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.81 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.81 KB

CrowdStrike logo

The Toucan Design System from CrowdStrike


CI status


Toucan provides a set of accessible and reusable components that make it easy to create visually consistent and efficient Ember applications. This repository is a monorepo publishing two packages:

  • ember-toucan-core
  • ember-toucan-form

The core package contains the Toucan-styled Ember components. The form package allows users to build forms using ember-headless-form with the core components.

Usage

Visit our documentation website.

Compatibility

  • Ember.js 4.8 or above
  • Embroider or ember-auto-import v2.0 or above
  • Glint

Installation

To use the presentational components in your Ember apps and addons, run one of the following.

pnpm add @crowdstrike/ember-toucan-core
# or
yarn add @crowdstrike/ember-toucan-core
# or
npm install @crowdstrike/ember-toucan-core
# or
ember install @crowdstrike/ember-toucan-core

If want to use our ember-headless-form abstraction that exposes the core form components, run one of the following.

pnpm add @crowdstrike/ember-toucan-form
# or
yarn add @crowdstrike/ember-toucan-form
# or
npm install @crowdstrike/ember-toucan-form
# or
ember install @crowdstrike/ember-toucan-form

Contributing

See the Contributing guide for details.