https://github.com/flybywiresim/react-components

FlyByWire Simulations React component library
https://github.com/flybywiresim/react-components

Last synced: about 2 months ago
JSON representation

FlyByWire Simulations React component library

• Host: GitHub
• URL: https://github.com/flybywiresim/react-components
• Owner: flybywiresim
• License: mit
• Created: 2021-02-05T00:50:49.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T01:31:23.000Z (10 months ago)
• Last Synced: 2025-04-10T04:34:39.677Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.77 MB
• Stars: 6
• Watchers: 19
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![FlyByWire Simulations](https://raw.githubusercontent.com/flybywiresim/branding/master/tails-with-text/FBW-Color-Dark.svg#gh-light-mode-only)

![FlyByWire Simulations](https://raw.githubusercontent.com/flybywiresim/branding/master/tails-with-text/FBW-Color-Light.svg#gh-dark-mode-only)

# FlyByWire Simulations React components library

## Installation

Install the library using npm:

    $ npm install --save @flybywiresim/react-components

## Development

### Testing

```

npm run test

```

### Building

```

npm run build

```

### Storybook

To run a live-reload Storybook server on your local machine:

```

npm run storybook

```

To export your Storybook as static files:

```

npm run storybook:export

```

You can then serve the files under `storybook-static` on GitHub pages.

### Generating New Components

To generate all the files needed to start building out a new component:

```

npm run generate YourComponentName

```

This will generate:

```

/src

  /YourComponentName

    YourComponentName.tsx

    YourComponentName.stories.tsx

    YourComponentName.test.tsx

    YourComponentName.types.ts

    YourComponentName.scss

    index.ts

```

The default templates for each file can be modified under `util/templates`.

Don't forget to add the component to your `index.ts` exports if you want the library to export the component!