Skip to content
Development kits to implement UI following the Workday Canvas Design System (https://design.workday.com)
TypeScript CSS JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ci: Temporarily convert to TravisCI while billing is being figured out ( Nov 16, 2019
.storybook chore: Add StaticStates wrapper (#377) Dec 26, 2019
cypress fix: Increase storybook test timeout (#402) Jan 9, 2020
jest chore: Upgrade to Emotion 10 (#246) Oct 22, 2019
modules fix(Select): Includes Select to CKR main exports (#410) Jan 13, 2020
utils feat(labs): Theming (react) (#272) Dec 6, 2019
.editorconfig feat: Init Jul 2, 2019
.eslintignore build: Replace TSLint with ESLint (#242) Oct 14, 2019
.gitignore test: Add Cypress modal specifications (#184) Oct 2, 2019
.npmrc chore: Add lint check for Artifactory paths Jul 3, 2019
.nvmrc feat: Init Jul 2, 2019
.postcss.json
.prettierignore build(travis): regenerate build vars (#27) Jul 3, 2019
.prettierrc.js chore: Use proper prettier file in configs (#348) Dec 3, 2019
.travis.yml chore: Upgrade to Chromatic 2.0 (#405) Jan 10, 2020
.vcmrc feat: Init Jul 2, 2019
.yarnrc chore: Add lint check for Artifactory paths Jul 3, 2019
API_PATTERN_GUIDELINES.md fix: Resolve lint and test warnings (#276) Oct 25, 2019
CHANGELOG.md chore: Release 3.2.0 (#392) Jan 7, 2020
CODE_OF_CONDUCT.md feat: Init Jul 2, 2019
COMPONENT_STATUS.md chore: Use proper prettier file in configs (#348) Dec 3, 2019
CONTRIBUTING.md Chore/remove snapshot tests (#259) Oct 14, 2019
CONTRIBUTORS.md feat: Init Jul 2, 2019
LICENSE feat: Init Jul 2, 2019
README.md
babel.config.js feat: Init Jul 2, 2019
commitlint.config.js
cypress.json ci: Create github action for CI and add Cypress to CI (#240) Oct 4, 2019
eslintrc.js chore: Use proper prettier file in configs (#348) Dec 3, 2019
jest.config.js feat(labs): Theming (react) (#272) Dec 6, 2019
lerna.json chore: Release 3.2.0 (#392) Jan 7, 2020
package.json docs: Fix Storybook iframe rendering (#401) Jan 8, 2020
tsconfig.json feat: Add Cypress tests to canvas-kit (#174) Sep 10, 2019
typings.d.ts feat: Init Jul 2, 2019
wallaby.js fix: Fix Wallaby config for labs components (#403) Jan 9, 2020
yarn.lock chore: Update Storybook Chromatic (#397) Jan 7, 2020

README.md

Workday Canvas Kit

This project provides a set of components for the Workday Canvas Design System that can be used to implement user experiences consistent with Workday's design principles.

Workday Canvas Kit is released under the Apache-2.0 license Travis CI Maintained with Lerna PRs welcome

For a list of available react modules see Canvas Kit Component Status

Getting started

React

Installation

To get started using Canvas kit React first add or install the module to your existing React project

yarn add @workday/canvas-kit-react

or

npm install @workday/canvas-kit-react

Usage

import * as React from 'react';
import {Button} from '@workday/canvas-kit-react';

<Button>Button Label</Button>;

CSS

Installation

To get started using Canvas kit CSS first add or install the module to your project

yarn add @workday/canvas-kit-css

or

npm install @workday/canvas-kit-css

Add your node_modules directory to your SASS includePaths. You will then be able to import index.scss.

Usage

@import '~@workday/canvas-kit-css/index.scss';

You must have PostCSS support. Add the postcss-inline-svg plugin to properly process and inline icons. Process your SASS through PostCSS once it has been compiled to CSS.

<button class="wdc-btn">Button Label</button>

Reporting a Bug

If you spot a bug, inconsistency, or typo, please open a bug issue. Better yet, submit a pull request to addresses it.

Feature Requests

If you have an idea, we would love to hear about it. The best way to suggest a feature is to open a feature issue. The Canvas Kit core team will take a look and discuss it with you.

Contributing

Want to contribute to Canvas Kit React? Please read our contributing guidelines to find out more and how to get started.

Open Development

All work on the Canvas Kit happens directly on GitHub. Both core team members and external contributors can send pull requests which go through the same review process. Any and all issues are public and available for discussion.

Versioning

Canvas Kit follows semantic versioning and is enforced automatically by conventional commits (see "Commit Message Format").

Each module is independently versioned using Lerna.

License

The Workday Canvas Kits are licensed under the Apache 2.0 License.

Supported Browsers

  • IE11
  • Microsoft Edge: last 2 versions
  • Mozilla Firefox: last 2 versions
  • Google Chrome: last 2 versions
  • Apple Safari: last 2 versions
  • Opera: last 2 versions

Thank you

Visual Testing by ChromaticQA

Builds by TravisCI

You can’t perform that action at this time.