Neanderthals Programming Machines

    @uit/glitch-image
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.11 • Public • Published

    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="https://unpkg.com/@uit/glitch-image/dist/glitch-image.js"
      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.

    Using this component

    Script tag

    • Put a script tag similar to this <script src='https://unpkg.com/@uit/glitch-image/dist/glitch-image.js'></script> in the head of your index.html
    • Then you can use the element anywhere in your template, JSX, html etc

    React

    • Run npm install @uit/glitch-image --save
    • Then, implement it by calling the loader as follows
    import { applyPolyfills, defineCustomElements } from "@uit/glitch-image/loader";
    
    applyPolyfills().then(() => {
      defineCustomElements();
    });
    
    export default function App() {
      return (
        <div className="App">
          <glitch-image src="..." />
        </div>
      );
    }

    Vue

    • Run npm install @uit/glitch-image --save
    • Then, implement it by calling the loader as follows
    <template>
      <div id="app">
        <glitch-image src="..." />
      </div>
    </template>
    
    <script>
    import { applyPolyfills, defineCustomElements } from "@uit/glitch-image/loader";
    
    applyPolyfills().then(() => {
      defineCustomElements();
    });
    
    export default {
      name: "App"
    };
    </script>

    Node Modules

    • Run npm install @uit/glitch-image --save
    • Put a script tag similar to this <script src='node_modules/@uit/glitch-image/dist/glitch-image.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 @uit/glitch-image --save
    • Add an import to the npm packages import @uit/glitch-image;
    • 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

    Keywords

    none

    Install

    npm i @uit/glitch-image

    DownloadsWeekly Downloads

    84

    Version

    0.0.11

    License

    MIT

    Unpacked Size

    185 kB

    Total Files

    12

    Last publish

    Collaborators

    • potato4d
    • leonardo_mbc
    • linecorp