@realequity/ui-components

ui-components

General rules

• ui-components all component tags starts with rui-* Ex. <rui-badge></rui-badge>
• ui-components is "dumb" in the way they can only use data provided through Prop()
• ui-components MUST have stories in Storybook
• Use functional components for simple things docs \
  • CHECK the limitations here

Async is written with async await, not .then()

(async () => {
  const result = await SomeMethod();
})();

And don't forget the () do execute the function.

Use getCompontWithArgs() in storybook-utils.ts to make components for stories.
This can also be used with a limitHeight: xxx to check scrolling

Each component is responsible for handling overflow and scrolling

Gotya's

camelCase Props() only works if you provide the name like this Prop({ attribute: 'camelCase' )

It is NOT possible to parse complex obejcts or arrays to a web-component like this:

<my-component actor={{ id: 'id' }}></my-component>

This can only be done using:

const myComponent = document.createElement('my-component');
myComponent.actor = { id: 'id' };

Use getCompontWithArgs() in storybook-utils.ts to create components for stories.

Stencil don't show an error when using await incorrectly. Ex. (await getSomething()) when getSomething is no returning a Promise<something>

There is no errors when using a non-existing component Ex. <a-non-existing-component></a-non-existing-component>

How to run stenciljs and storybook for development

Run

To install packages

npm i

In 1 terminal run:

npm run build:watch
wait for the build to finish before running the next.

In 2 terminal run:

npm run storybook

To publish a new version to NPM

Commit changes

git commit -m "Your commit message"
run npm version patch
git push

Use in other projects

npm i add @realequity/ui-components

---

\

Stencil Component Starter

This is a starter project for building a standalone Web Component using Stencil.

Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.

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 using Stencil, clone this repo to a new directory:

git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin

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 not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to publish to NPM.

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install my-component --save
• Put a script tag similar to this <script src='node_modules/my-component/dist/my-component.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

• Run npm install my-component --save
• Add an import to the npm packages import my-component;
• Then you can use the element anywhere in your template, JSX, html etc