0.0.106 • Published 2 years ago

forms-web-comp v0.0.106

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

UNOapp Components

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Getting Started

To start building a new web component, clone this repo to a new directory:

git clone https://link-to-repo unoapp-components
cd unoapp-components

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, the tag should always be prefaced with unoapp- and then the name of the component. Example: unoapp-applications would be a component that displays the applications.

Creating a new Component

When creating a new component, you will need to create a name branch prefaced with comp/ and then the name of your component. Example: comp/applications would represent the branch for a new component named unoapp-applications

New components should be placed inside of a new directory within /src/components. Example: src/components/applications.

Once you are done working on the component and feel it's ready to be used by the rest of the team, you can make a pull request into the 'develop' branch so that the component can be merged and made available to the rest of the team to use within their applications.

Component Documentation

unoapp-account-modal

Properties

PropertyAttributeDescriptionTypeDefault
authTokenauth-tokenstringundefined

Events

EventDescriptionType
unoappBusinessSelectedCustomEvent<string>