@flywire/react-headlessui

@flywire/react-headlessui

A collection of unstyled and fully accessible UI components used in Flywire.

Documentation

The documentation and examples are hosted in https://flywire-ui-docs.flywire.com.

Installation

Install dependencies with npm:

npm install @flywire/react-headlessui

Run Locally

Clone the project

git clone [e-mail]:flywire/development/react-headlessui.git

Go to the project directory

cd react-headlessui

Install dependencies

npm install

Start the server

npm run doc

Running Tests

To run tests, run the following command

npm run test

Releases

To create a new release, make all the changes that you need and commit them, then execute:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]

For example:

npm version patch
npm publish

or for a beta:

npm version prepatch
npm publish --tag beta

This will bump the package.json version, build a new bundle, commit, push the changes tagging them to a new release.

Then create a PR and request the review from other project commiters. Once accepted and merged to master, execute npm publish from master branch.