0.1.1 • Published 6 years ago

@paraboly/chmod-checkbox v0.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Built With Stencil

CHMOD based animated checkbox WebComponent with StencilJS

npm version npm Platform - Android and iOS License: MIT styled with prettier

Chmod Checkbox comes with three (3) animated checkbox which includes READ, WRITE and EXECUTE values. These text values are customizable. It has built-in chmod calculator for each value.

Fundamental CHMOD Architecture

ValueRWXDescription
0000NO_PERMISSION
1100READ
2010WRITE
3110READ/WRITE
4001EXECUTE
5101READ/EXECUTE
6011WRITE/EXECUTE
7111ALL

Installation

First Install the Peer Dependency

This peer dependency is essential for this library! You need to install it

npm i @paraboly/pwc-animated-checkbox

Script tag (Recommended: Painless)

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

Usage

<chmod-checkbox permission="0" />

How to get value from a prop?

document.querySelectorAll("chmod-checkbox")[0].permission
document.querySelectorAll("chmod-checkbox")[0].first
document.querySelectorAll("chmod-checkbox")[0].middle
document.querySelectorAll("chmod-checkbox")[0].last

Configuration - Props

PropertyTypeDefaultDescription
permissionnumber0get the changing permission value

Future Plans

  • LICENSE
  • Customizable colors
  • Make another web-component with just animated checkbox and implement it on this library
  • Write an article about the lib on Medium

Author

FreakyCoder, kurayogun@gmail.com

License

WebComponent Chmod Checkbox is available under the MIT license. See the LICENSE file for more info.