https://github.com/edgeworkscreative/ewc-social

EWC Social Component
https://github.com/edgeworkscreative/ewc-social

social-buttons stenciljs-components

Last synced: about 1 month ago
JSON representation

EWC Social Component

• Host: GitHub
• URL: https://github.com/edgeworkscreative/ewc-social
• Owner: edgeworkscreative
• License: mit
• Created: 2018-09-13T19:45:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-28T15:38:24.000Z (over 6 years ago)
• Last Synced: 2024-11-29T01:39:11.690Z (about 1 month ago)
• Topics: social-buttons, stenciljs-components
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@edgeworkscreative/ewc-social
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# 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

```html

```

## 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 `` 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 `` 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.