Have ideas to improve npm?Join in the discussion! ¬Ľ

    @granite-elements/granite-qrcode-generator

    2.0.3¬†‚Äʬ†Public¬†‚Äʬ†Published

    Published on Vaadin  Directory Stars on vaadin.com/directory Published on webcomponents.org

    <granite-qrcode-generator>

    A custom element to generate and render a QR Codes, using qr.js library

    Built on lit-element following the open-wc recommendation.

    The old Polymer 2.x-1.x version is available on the polymer-hybrid branch.

    Installation

    npm i @granite-elements/granite-qrcode-generator

    Usage

    <script type="module">
      import 'granite-qrcode-generator/granite-qrcode-generator.js';
    </script> 
     
    <granite-qrcode-generator 
        data="https://github.com/lostinbrittany/granite-elements"
        mode="alphanumeric"
        auto></granite-qrcode-generator>

    Linting with ESLint, Prettier, and Types

    To scan the project for linting errors, run

    npm run lint

    You can lint with ESLint and Prettier individually as well

    npm run lint:eslint
    npm run lint:prettier

    To automatically fix many linting errors, run

    npm run format

    You can format using ESLint and Prettier individually as well

    npm run format:eslint
    npm run format:prettier

    Testing with Karma

    To run the suite of karma tests, run

    npm run test

    To run the tests in watch mode (for TDD, for example), run

    npm run test:watch

    Demoing with Storybook

    To run a local instance of Storybook for your component, run

    npm run storybook

    To build a production version of Storybook, run

    npm run storybook:build

    Tooling configs

    For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

    If you customize the configuration a lot, you can consider moving them to individual files.

    Local Demo with es-dev-server

    npm start

    To run a local development server that serves the basic demo located in demo/index.html

    Contributing

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -m 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    License

    MIT License

    Install

    npm i @granite-elements/granite-qrcode-generator

    DownloadsWeekly Downloads

    13

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    42.7 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar