npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@workday/canvas-kit-preview-react

v12.1.5

Published

Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.

Downloads

6,499

Readme

Canvas Kit Preview

This is a group of coming-soon components that have had a full design and a11y review, and are approved for use in product. Their functionality and design are set, but the APIs and/or underlying architecture could still be subject to change. This bundle serves as a staging ground for components that are ready to use, but may not be up to the high code standards upheld in the main @workday/canvas-kit-react bundle.

Generally, Canvas Kit Preview components were originally in Canvas Kit Labs and have been promoted. Essentially, Canvas Kit Labs is for alpha components and Canvas Kit Preview is for beta components.

Breaking Changes

Due to the nature of this bundle of components, we will be continuously iterating. This could potentially mean a breaking change (though much less likely than Labs components). The goal of this bundle is to work unconstrained by our design system's semantic versioning. This means that breaking changes can be deployed to Preview modules at any time and it will not trigger a major version bump across our other modules. Regardless of the fact that we use a fixed version number for all components, all changes/additions in this bundle will never result in a major version bump across our component library. Should breaking changes arise, we will provide strong communication and migration strategies.

By consuming any of these modules, you acknowledge the potential complexity of updating and ultimately performing a migration when components are promoted to a stable version.

These components are purely opt in, so they are not included in the main module @workday/canvas-kit-react.

Support

  • Docs & examples
  • Change announcements & migration strategies
  • Longer stretches between any potential breaking changes
  • Migration to main module might still require some effort
  • Direct support is available, but we prioritize Main components first

Module Structure

/modules
  ...
  /preview-react
    /new-component
      /* Standard React component structure */

Creating a Canvas Kit Preview Component

  1. Run yarn create-component
  2. When asked What category should this component live in?, select Preview (beta).
  3. Your new module will be generated in accordance with the file structure above. It will get a package name of @workday/canvas-kit-preview-react/<COMPONENT>.
  4. If you had the storybook server running, you may need to restart it.

Promoting a Component out of Canvas Kit Preview

  1. Run yarn promote-component