Skip to content

sheeshpaul/everyday-webcomponents

Repository files navigation

everyday-webcomponents

everyday-webcomponents is a collection of commonly used Web UIs as Native Web Components. The everyday-components are very light weight, accessible, written using vanilla web component APIs and does not use any framework.

Quick Start Guide

Installation

Script Tag

Single bundle for all the components.

<script src='https://unpkg.com/everyday-webcomponents/dist/everyday-webcomponents.min.js'></script>

Bundle for individual component.

// Card component bundle
<script src='https://unpkg.com/everyday-webcomponents/dist/everyday-ew-card-webcomponent.min.js'></script>

// Image Card component bundle
<script src='https://unpkg.com/everyday-webcomponents/dist/everyday-ew-image-card-webcomponent.min.js'></script>

// Carousel component bundle
<script src='https://unpkg.com/everyday-webcomponents/dist/everyday-ew-carousel-webcomponent.min.js'></script>

ES Module

npm install --save everyday-webcomponents
import 'everyday-webcomponents';

CommonJS Module

npm install --save everyday-webcomponents
require('everyday-webcomponents');

Components

Card Component

The card component comes in three variations, small, regular, and compact.

Card component image

HTML Markup

<ew-card type="small" text="Lorem ipsum dolor sit amet" link="https://unsplash.com"></ew-card>
<ew-card text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/random/300x174" link="https://unsplash.com"></ew-card>
<ew-card type="compact" text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/random/300x174" link="https://unsplash.com"></ew-card>

Supported Attributes/Props

  • type: By default card renders as a regular card. Use type small to render as a small card. Use type compact to render as a compact card.
  • text: The text to show in card.
  • image: The image to show in card.
  • link: The link to navigate to when card is clicked.

Supported Themeing Options

  • --ew-background: Set this CSS variable to change the background color.
  • --ew-color: Set this CSS variable to change the font color.
  • --ew-font-family: Set this CSS variable to change the font family.
  • --ew-font-size: Set this CSS variable to change the font size.

Codepen Example

Image Card Component

The image card component comes in regular and large variations.

Image card component image

HTML Markup

<ew-image-card text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/random/200x150" link="https://unsplash.com"></ew-image-card>
<ew-image-card type="large" text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/random/620x350" link="https://unsplash.com"></ew-image-card>

Supported Attributes/Props

  • type: By default image card renders as a regular card. Use type large to render as a large image card.
  • text: The text to show in card.
  • image: The image to show in card.
  • link: The link to navigate to when card is clicked.

Supported Themeing Options

  • --ew-background: Set this CSS variable to change the background color.
  • --ew-color: Set this CSS variable to change the font color.
  • --ew-font-family: Set this CSS variable to change the font family.
  • --ew-font-size: Set this CSS variable to change the font size.

Codepen Example

Carousel Component

The carousel component comes in regular and large variations.

Carousel component image

HTML Markup

<ew-carousel>
    <ew-carousel-slide text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/620x350/?nature,water" link="https://unsplash.com"></ew-carousel-slide>
    <ew-carousel-slide text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/620x350/?cars,audi" link="https://unsplash.com"></ew-carousel-slide>
    <ew-carousel-slide text="Lorem ipsum dolor sit amet" image="https://source.unsplash.com/620x350/?animal,dog" link="https://unsplash.com"></ew-carousel-slide>
</ew-carousel>

Carousel Supported Attributes/Props

  • type: By default carousel renders as a regular carousel. Use type large to render as a large carousel.

Carousel Slide Supported Attributes/Props

  • text: The text to show in slide.
  • image: The image to show in slide.
  • link: The link to navigate to when slide is clicked.

Carousel Slide Supported Themeing Options

  • --ew-background: Set this CSS variable to change the background color.
  • --ew-color: Set this CSS variable to change the font color.
  • --ew-font-family: Set this CSS variable to change the font family.
  • --ew-font-size: Set this CSS variable to change the font size.

Codepen Example

License

MIT

About

Native web components for everyday use.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published