Code Monkey home page Code Monkey logo

wca-components's Introduction

wca-components

The React Component Library for the WCA

Usage

  1. Install the library as a npm package with npm install @thewca/wca-components
  2. Import the component you want to use with import { CubingIcon } from "@thewca/wca-components"
  3. Import the styles in your app with import '@thewca/wca-components/dist/index.esm.css'

Contributing

Working on Existing Components

If you want to work on an existing component the easiest way is to run npm run storybook and navigate to the component. It will update with changes in the code

Creating new Components

The Components are written using typescript, so they can provide useful type information for developers.
When you are transitioning a Rails Component to React or you are building a new React Component you can add it to the Component Library following these steps

  1. Fork the repository
  2. Create a new Folder in the components folder
  3. Write your component and provide type information for its props
    1. If your component has a state that would make sense to communicate to a parent component make sure to provide callback functions that are triggered on state changes
  4. Write tests for your components using jest
    1. You can also add a Story to your component using Storybook to more easily visualize how arguments affect your component and how to interact with it. See an example in EventSelector.stories.tsx
  5. Create an index.ts in your directory to export your component and add its desired exported name to src/components/index.ts
  6. Create a PR with your changes

wca-components's People

Contributors

finnickler avatar alexandreondet 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.