Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@cesarbr/macaw

0.0.3 • Public • Published

Built With Stencil

Macaw

Getting Started

To start development:

git clone git@gitlab.com:cesarbr/cesar-apps/macaw/macaw.git
cd macaw

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend using prefix m-. For example m-button.

Using this component

Script tag

  1. Put a script tag <script src='https://unpkg.com/@cesarbr/macaw/dist/macaw.js'></script> in the head of your index.html
  2. Then you can use the element anywhere in your template, JSX, html etc

NPM

  1. Run
$ npm install  @cesarbr/macaw --save
  1. Add an import to the npm packages
import { defineCustomElements as macaw } from '@cesarbr/macaw/loader';
  1. Init macaw
macaw(window);
  1. Then you can use the element anywhere in your template, JSX, html etc

Install

npm i @cesarbr/[email protected]

Version

0.0.3

License

MIT

Unpacked Size

1.03 MB

Total Files

164

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar