Skip to content

edgeworkscreative/ewc-social

Repository files navigation

Built With Stencil

Edgeworks Creative Social Component

A lightweight social icons 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-social labels="true" facebook="https://www.facebook.com/edgeworkscreative/"></ewc-social>

Documentation

Properties

all url properties require a full url eg. https://edgeworkscreative.com/

Property Attribute Description Type
facebook facebook facebook page url string
googlePlus google-plus google plus page url string
instagram instagram instagram page url string
linkedin linkedin linkedin page url string
pinterest pinterest pinterest page url string
snapchat snapchat snapchat page url string
twitter twitter twitter page url string
vimeo vimeo vimeo page url string
youtube youtube youtube page url string
labels labels enable or disable labels boolean

CSS Variables

Can be targeted via css using the tag for the component. eg. ewc-social{--color:white;}

Variable Description
--color icon and text color
--font-size list item font size
--justify flex box content justification

Using this component

Script tag

  • Put a script tag similar to this <script src='https://unpkg.com/@edgeworkscreative/ewc-social@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-social --save
  • Put a script tag similar to this <script src='node_modules/@edgeworkscreative/ewc-social/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-social --save
  • Add an import to the npm packages import '@edgeworkscreative/ewc-social';
  • 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.