Apwide's ui component, loosely built according to the Atlassian Design Guidelines on top of @apwide/uikit.
npm install @apwide/uikit
//
// Register a component manually for optimal tree shaking
//
import { Spinner } from '@apwide/uikit';
export default {
components: {
Spinner
},
};
You must import it to your webpack entry point file. This is usually your main.js
file.
import '@apwide/uikit/dist/bundle.css';
Pushing or merging to the main
branch (aka normal development):
- runs the tests
- updates the minor version in package.json
- releases the new version to NPM
- generates the docs site
- deploys the docs to gh-pages
Pushing to a patch
branch (aka production patch)
Same things happen except it increment by patch level.
If a major bump is required, the work BREAKING must be in a git commit (on main
)
If you need to work on a project with an unreleased version of this library:
- in this project directory:
<npm|yarn> link
- in the other project's directory:
<npm|yarn> link @apwide/uikit
To stop, make sure to unlink <npm|yarn> unlink @apwide/uikit
and read to output for further actions to perform on your project.
If you use Node >16 make sure to add export NODE_OPTIONS=--openssl-legacy-provider
before running storybook (npm run storybook
).