# Zea Web Components Zea's web components library ![Node.js CI](https://github.com/ZeaInc/zea-web-components/workflows/Node.js%20CI/badge.svg) ![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square) ## Design System ### Components All the links are also listed in Zeplin. On the right-hand side. https://xd.adobe.com/view/0d27d0ea-8c36-430c-503e-8b88b092852d-7b16/grid https://app.zeplin.io/project/5dcc8791cb8f1916972ec384/dashboard ### Big screens https://xd.adobe.com/view/a0915b59-eadd-41b3-53e6-a71c54b369a9-d6a0/grid ### Small screens https://xd.adobe.com/spec/789ee951-6051-40f4-4b28-36ed4628358d-0eaf/grid/ ### Inspiration https://material-ui.com/ https://github.com/material-components/material-components-web-components ## How To ### Generate a new component ```bash yarn run generate ``` # CSS Themes ## Dark ``` :root { --ion-color-primary: #f9ce03; --ion-color-primary-tint: #fbe167; --theme-font-family: 'Roboto', sans-serif; --color-primary-1: #f9ce03; --color-primary-2: #fbe167; --color-primary-3: #594f1f; --color-secondary-1: #965cb8; --color-secondary-2: #c09dd4; --color-secondary-3: #3b3340; --color-warning-1: #e52011; --color-warning-2: #ef7970; --color-warning-3: #572724; --color-success-1: #8bc34a; --color-success-2: #b9db92; --color-success-3: #424f32; --color-background-1: #222222; --color-background-2: #292929; --color-background-3: #2d2d2d; --color-background-4: #101010; --color-foreground-1: #e0e0e0; --color-foreground-2: #aaaaaa; --color-foreground-3: #8a8a8a; --color-grey-1: #333333; --color-grey-2: #393939; --color-grey-3: #4e4e4e; --color-button-text-1: #222222; --color-button-text-2: #ffffff; --color-disabled-1: #242424; --color-disabled-2: #4b4b4b; --color-shadow: #00000026; } ``` ## Light ``` :root { --ion-color-primary: #f9ce03; --ion-color-primary-tint: #fbe167; --theme-font-family: 'Roboto', sans-serif; --color-primary-1: #f9ce03; --color-primary-2: #fbe167; --color-primary-3: #594f1f; --color-secondary-1: #8b52af; --color-secondary-2: #b892ce; --color-secondary-3: #f2ebf7; --color-warning-1: #e52011; --color-warning-2: #ef7970; --color-warning-3: #fad2cf; --color-success-1: #8bc34a; --color-success-2: #b9db92; --color-success-3: #e8f3db; --color-background-1: #ffffff; --color-background-2: #ffffff; --color-background-3: #f5f5f5; --color-background-4: #ffffff; --color-foreground-1: #333333; --color-foreground-2: #7a7a7a; --color-foreground-3: #989898; --color-grey-1: #f5f5f5; --color-grey-2: #eaeaea; --color-grey-3: #d6d6d6; --color-button-text-1: #ffffff; --color-button-text-2: #333333; --color-disabled-1: #b8b8b8; --color-disabled-2: #e8e8e8; --color-shadow: #00000026; } ``` # 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](https://github.com/ionic-team/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: ```bash git clone https://github.com/ionic-team/stencil-component-starter.git my-component cd my-component git remote rm origin ``` and run: ```bash yarn install yarn run start ``` To build the component for production, run: ```bash yarn run build ``` To run the unit tests for the components, run: ```bash yarn test ``` Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component). ## Naming Components When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: ``). 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 ### Script tag - [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages) - Put a script tag similar to this `` in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc ### Node Modules - Run `yarn add @zeainc/zea-web-components` - Put a script tag similar to this `` 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 `yarn add @zeainc/zea-web-components` - Add an import to the npm packages `import '@zeainc/zea-web-components'` - Then you can use the element anywhere in your template, JSX, html etc