JSPM

@bc-digital/bronte

0.2.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q80493F
  • License MIT

Component library built with stylable.

Package Exports

  • @bc-digital/bronte

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@bc-digital/bronte) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm run scaffold component ComponentName

Use when you want to create a new component.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Publishing to NPM

  • Update the version in package.json
  • Run npm publish

Note: If this is your first publish, you may need to run npm login

Process of creating components for dummies and those with short memory :)

  • On your branch, run in terminal: npm run scaffold component YourComponent.
  • Create examples folder, with examples.tsx in YourComponent folder.
  • Use your README.mdx to describe and demonstrate YourComponent and related examples.
  • Add a relevant link in src/docs/components/ComponentMenu/ComponentMenu.tsx.
  • Import YourComponent into src/themes/default/index.ts and export const.
  • Create a skeleton of your styles in YourComponent folder - .st.css file, with .root {}, and other classes in it, e.g. .divider{}.
  • Create your elaborated styles in src/themes/default/css - if this is a default theme version of YourComponent, or/and under a different theme name (currently arts), if there is something specific for that theme.
  • List YourComponent within src/main.ts.