pe-web-components

ProctorExam web components library.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
pe-web-components
0.0.173 months ago6 months agoMinified + gzip package size for pe-web-components in KB

Readme

Built With Stencil
ProctorExam Web Components Library
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://gitlab.com/proctorexam1/experiments/pe-web-components pe-web-components
cd pe-web-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

To run linter with auto-fix
npm run lint

To run prettier with auto-fix
npm run prettier

Need help? Check out our docs here.

Storybook

To run storybook (Requires node v16.x.x)
npm run build
npm run build-storybook
npm run storybook
open it on the browser using the port that you got from the terminal

File Structure

├── src
│   ├── components
│   │   ├── blocks
│   │   │   └── pe-video-player
│   │   ├── elements
│   │   │   ├── pe-button
│   │   │   ├── pe-video
│   │   │   └── pe-video-controls
│   │   └── shells
│   │       └── pe-review-studio
In order to create boilerplate:

npm run generate --name blocks/pe-video-player
npm run generate --name elements/pe-video-controls
npm run generate --name shells/pe-review-studio

elements

Contains UI build blocks. Packages here deals with low level user interactions and interfaces.

blocks

Contains high level components. Packages here deals with business logic and common tasks.

shells

Contains app shells. Packages here are complete products to be served as pages or eventually micro frontends.

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