0.4.1 • Published 4 years ago

@ubcdigital/tools v0.4.1

Weekly downloads
1
License
BSD-3-Clause
Repository
github
Last release
4 years ago

UBC Digital Tools from Using Blockchain Ltd

npm-badge size-badge dl-badge Build Status

Web Components Library for UBC Digital Tools from Using Blockchain Ltd.

NOTE: The author of this package cannot be held responsible for any loss of money or any malintentioned usage forms of this package. Please use this package with caution.

Components Found Here

You can use any of the following custom elements when @ubcdigital/tools is imported:

ComponentDescription
<about-ubcdigital-tools>Introduction to UBC Digital Tools from Using Blockchain Ltd
<smart-article>Canvas for Smart Article (Article4Us)

Usage

Node modules

You can import the library into your Vue, React, Angular or vanilla Javascript projects with NPM as follows:

$ npm install @ubcdigital/tools

Script tag

You can import the library directly into your HTML files with following <script> tag examples:

  <!-- Include UBC Digital Tools Styles -->
  <link rel="stylesheet" href="https://unpkg.com/@ubcdigital/tools@0.4.0/dist/ubcdigitaltools/ubcdigitaltools.css">

  <!-- (Optional) Add polyfills for web-components in older browsers -->
  <script nomodule src="https://unpkg.com/@webcomponents/webcomponentsjs@2.4.3/webcomponents-bundle.js"></script>

  <!-- Add modern browser support for UBC Digital Tools (ES Module) -->
  <script type="module" src="https://unpkg.com/@ubcdigital/tools@0.4.0/dist/ubcdigitaltools/ubcdigitaltools.esm.js"></script>

  <!-- (Optional) Add older browser support for UBC Digital Tools (IE 11 / Edge) -->
  <script nomodule="" src="https://unpkg.com/@ubcdigital/tools@0.4.0/dist/ubcdigitaltools.js"></script>

Then you can use the custom elements anywhere in your template, Vue files, JSX, HTML, etc.

Getting help

Use the following available resources to get help:

Contributing

This project is developed and maintained by Using Blockchain Ltd.

Contributions are welcome and appreciated. Check CONTRIBUTING for information on how to contribute.

License

Copyright 2020-present Grégory Saive for Using Blockchain Ltd, All Rights Reserved.

Licensed under the BSD 3-Clause License.