https://github.com/paraboly/web-component-chmod-checkbox

CHMOD based animated checkbox WebComponent with StencilJS
https://github.com/paraboly/web-component-chmod-checkbox

animated animated-checkbox animation checkbox chmod chmod-checkbox freakycoder front-end html jsx paraboly stenciljs ui web web-component web-components

Last synced: 3 months ago
JSON representation

CHMOD based animated checkbox WebComponent with StencilJS

• Host: GitHub
• URL: https://github.com/paraboly/web-component-chmod-checkbox
• Owner: Paraboly
• License: mit
• Created: 2019-09-30T12:47:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-11T08:19:01.000Z (almost 4 years ago)
• Last Synced: 2025-02-01T00:23:43.781Z (4 months ago)
• Topics: animated, animated-checkbox, animation, checkbox, chmod, chmod-checkbox, freakycoder, front-end, html, jsx, paraboly, stenciljs, ui, web, web-component, web-components
• Language: TypeScript
• Homepage: https://paraboly.com
• Size: 285 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=for-the-badge)



[![CHMOD based animated checkbox WebComponent with StencilJS](https://img.shields.io/badge/-CHMOD%20based%20animated%20checkbox%20WebComponent%20with%20StencilJS-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/web-component-chmod-checkbox)

[![npm version](https://img.shields.io/npm/v/@paraboly/chmod-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/chmod-checkbox)

[![npm](https://img.shields.io/npm/dt/@paraboly/chmod-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/chmod-checkbox)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/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

| Value | R   | W   | X   | Description   |

| ----- | --- | --- | --- | ------------- |

| 0     | 0   | 0   | 0   | NO_PERMISSION |

| 1     | 1   | 0   | 0   | READ          |

| 2     | 0   | 1   | 0   | WRITE         |

| 3     | 1   | 1   | 0   | READ/WRITE    |

| 4     | 0   | 0   | 1   | EXECUTE       |

| 5     | 1   | 0   | 1   | READ/EXECUTE  |

| 6     | 0   | 1   | 1   | WRITE/EXECUTE |

| 7     | 1   | 1   | 1   | ALL           |

## Installation

## First Install the Peer Dependency

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

### [pwc-animated-checkbox](https://github.com/Paraboly/pwc-animated-checkbox)

```js

npm i @paraboly/pwc-animated-checkbox

```

### Script tag (Recommended: Painless)

- Put a script tag similar to this `` 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 `` 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

```html

```

## How to get value from a prop?

```js

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

| Property   |  Type  | Default | Description                       |

| ---------- | :----: | :-----: | --------------------------------- |

| permission | number |    0    | get the changing permission value |

### Future Plans

- [x] ~~LICENSE~~

- [ ] Customizable colors

- [x] ~~Make another web-component with just animated checkbox and implement it on this library~~

- [ ] Write an article about the lib on Medium

## Author

FreakyCoder, [email protected]

## License

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