@stories-js/core

Stories Web Core

This is the library represents the set of Web Components for Stories build on Stencil Web Compponents and Stencil compiler.

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.

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

Clone and build yourself

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

git clone https://github.com/storiesjs/stories.git stories
cd stories

and run:

yarn install

To build the component for production, run:

yarn run build:all

To run the unit tests for the components, run:

yarn run test:all

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 Stories generated web components use the prefix stories. Run the following script in your terminal, answer several questions to generate new web component:

yarn run generate

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 type='module' src='https://cdn.jsdelivr.net/npm/@stories-js/core@latest/dist/cjs/index.cjs.min.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 @stories-js/stories --save
• Put a script tag similar to this <script type='module' src='node_modules/@stories-js/core/dist/esm/index.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 @stories-js/stories --save
• Add an import to the npm packages import '@stories-js/stories';
• Then you can use the element anywhere in your template, JSX, html etc