0.0.1 • Published 5 years ago

glitch-image v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

Built With Stencil

It's easy to use, just put the file path to the image in the src attribute, like the tag.

<script
  src="TODO: Set the URL of the uploaded module"
  type="module"
></script>

<div style="width: 250px; height: 250px;">
  <glitch-image src="uit-logo.svg"></glitch-image>
</div>

What is the glitch effect?

The glitch effect is an expressive technique that creates a situation where a digital device is unable to display the correct image due to noise or error.
So, it is not like a static error, but rather a partial error in phase/hue.

WIP Using this component

Script tag

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

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/uit-community/glitch-image.git glitch-image
cd glitch-image
git remote rm origin

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

0.0.1

5 years ago