Introduction

Web components for the Valais Media Library for the library applications.

Usage

Use one of this solution to "install" the mv-web-components in your project.

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/@valais-media-library/mv-web-components@latest/dist/mv-web-components.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 @valais-media-library/mv-web-components --save
• Put a script tag similar to this <script src='node_modules/@valais-media-library/mv-web-components/dist/mv-web-components.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 @valais-media-library/mv-web-components --save
• Add an import to the npm packages @valais-media-library/mv-web-components;
• Then you can use the element anywhere in your template, JSX, html, etc.

Documentation

Check the documentation for more informations : Comming soon…

To start

• serve the project : $ npm run start
• build the project : $ npm run build
• test the project : $ npm run test
• publish the build : $ npm run publish

Need help? Check out the stencil.js documentation here.

Authors and acknowledgment

• Generator: 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.

• Michael Ravedoni - Initial work - michaelravedoni

See also the list of contributors who participated in this project.

License

MIT License