@edgeworkscreative/ewc-slides

Lightweight slider component built with StencilJS

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Sep 5, 2018Aug 14, 2018Minified + gzip package size for @edgeworkscreative/ewc-slides in KB

Readme

Built With Stencil

Edgeworks Creative Slides Component

A lightweight slider component built with StencilJS.

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

Example

<ewc-slides>
  <ewc-slide>
    <img src="http://via.placeholder.com/550x500?text=test 1"/>
  </ewc-slide>
  <ewc-slide>
    <img src="http://via.placeholder.com/550x500?text=test 2"/>
  </ewc-slide>
  <ewc-slide>
    <img src="http://via.placeholder.com/550x500?text=test 3"/>
  </ewc-slide>
  <ewc-slide>
    <img src="http://via.placeholder.com/550x500?text=test 4"/>
  </ewc-slide>
  <ewc-slide>
    <img src="http://via.placeholder.com/550x500?text=test 5"/>
  </ewc-slide>
</ewc-slides>

Documentation

Using this component

Script tag

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

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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.