@pernod-ricard/design-system v1.2.20

Pernod Ricard - Design System

Introduction

This repository is a composition (mix) of Stencil.js and Storybook.

It was initially created starting from Stencil starter kit : https://github.com/ionic-team/stencil-component-starter.git

Installation

First install the dependencies:

npm install

Stencil

To build the web components using stencil for production, run:

npm run build

To start stencil dev server and visualize web components:

npm run start

then open up http://localhost:3333/

If you are a developer and want to add a new component to this wonderful design system, use:

npm run generate

To run the unit tests for the components, run:

npm test

Storybook

Shall you want to run Storybook:

npm run storybook

To generate storybook as a static website:

npm run build-storybook -- -o ./storybook-static

or simply:

npm run build-storybook

This will create a static website that you can expose with any web server. If you are lazy (I know you are), you can run:

npx http-server ./storybook-static

Docker

To make your life easier, we provide a Docker image that basically contains this entire repository and everything you need to work with it.

To build the docker image

docker build -t design-system .

To run stencil:

docker run -it pernodricard/design-system npm run start

To run Storybook:

docker run -it pernodricard/design-system npm run storybook

Default Stencil Readme (just in case)

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.

Visual Studio Code

The .vscode directory is shared to facilitate the configuration of another environment. This includes the configuration of the editor but also the test part with Jest.

Here is a list of useful Visual studio code extensions :

• Auto Rename tag
• Conventional Commits
• Eslint
• Sass
• es6-string-html
• SCSS IntelliSense
• Stencil Tools

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 type='module' 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 type='module' 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