Skip to content

Commit 935beb4

Browse files
committed
README is updated with new ss
1 parent 23bb79a commit 935beb4

File tree

3 files changed

+54
-43
lines changed

3 files changed

+54
-43
lines changed

assets/Screenshots/example.gif

192 KB
Loading

assets/Screenshots/example.png

32.2 KB
Loading

readme.md

Lines changed: 54 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,83 @@
11
![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=flat-square)
2+
<img alt="WebComponent Chmod Checkbox" src="https://github.com/WrathChaos/web-component-chmod-checkbox/blob/master/assets/logo.png" width="1050"/>
23

3-
# Stencil Component Starter
44

5-
This is a starter project for building a standalone Web Component using Stencil.
5+
[![CHMOD based animated checkbox WebComponent with StencilJS](https://img.shields.io/badge/-React%20Native%20Library%20Boilerplate-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/web-component-chmod-checkbox)
66

7-
Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.
87

9-
# Stencil
8+
[![npm version](https://img.shields.io/npm/v/web-component-chmod-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/web-component-chmod-checkbox)
9+
[![npm](https://img.shields.io/npm/dt/web-component-chmod-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/web-component-chmod-checkbox)
10+
![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)
11+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
12+
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)
1013

11-
Stencil is a compiler for building fast web apps using Web Components.
14+
<p align="center">
15+
<img alt="WebComponent Chmod Checkbox" src="assets/Screenshots/example.gif" />
16+
<img alt="WebComponent Chmod Checkbox" src="assets/Screenshots/example.png" />
17+
</p>
1218

13-
Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.
1419

15-
Stencil components are just Web Components, so they work in any major framework or with no framework at all.
20+
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.
1621

17-
## Getting Started
1822

19-
To start building a new web component using Stencil, clone this repo to a new directory:
23+
## Fundamental CHMOD Architecture
2024

21-
```bash
22-
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
23-
cd my-component
24-
git remote rm origin
25-
```
2625

27-
and run:
26+
| Value | R | W | X | Description |
27+
| ----- | --- | --- | --- | ------------- |
28+
| 0 | 0 | 0 | 0 | NO_PERMISSION |
29+
| 1 | 1 | 0 | 0 | READ |
30+
| 2 | 0 | 1 | 0 | WRITE |
31+
| 3 | 1 | 1 | 0 | READ/WRITE |
32+
| 4 | 0 | 0 | 1 | EXECUTE |
33+
| 5 | 1 | 0 | 1 | READ/EXECUTE |
34+
| 6 | 0 | 1 | 1 | WRITE/EXECUTE |
35+
| 7 | 1 | 1 | 1 | ALL |
2836

29-
```bash
30-
npm install
31-
npm start
32-
```
3337

34-
To build the component for production, run:
38+
## Installation
3539

36-
```bash
37-
npm run build
38-
```
40+
### Script tag (Recommended: Painless)
41+
- Put a script tag similar to this `<script src="https://unpkg.com/chmod-checkbox@latest/dist/chmod-checkbox.js"></script>` in the head of your index.html
42+
- Then you can use the element anywhere in your template, JSX, html etc
3943

40-
To run the unit tests for the components, run:
44+
### Node Modules
45+
- Run `npm install chmod-checkbox --save`
46+
- Put a script tag similar to this `<script src='node_modules/chmod-checkbox/dist/chmod-checkbox.js'></script>` in the head of your index.html
47+
- Then you can use the element anywhere in your template, JSX, html etc
48+
49+
### In a stencil-starter app
50+
- Run `npm install chmod-checkbox --save`
51+
- Add an import to the npm packages `import chmod-checkbox;`
52+
- Then you can use the element anywhere in your template, JSX, html etc
4153

42-
```bash
43-
npm test
54+
# Usage
55+
56+
```html
57+
<chmod-checkbox permission="0" />
4458
```
4559

46-
Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
4760

61+
### Configuration - Props
4862

49-
## Naming Components
5063

51-
When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
64+
| Property | Type | Default | Description |
65+
| ---------- | :----: | :-----: | --------------------------------- |
66+
| permission | number | 0 | get the changing permission value |
5267

53-
Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix `ion`.
5468

69+
### Future Plans
5570

56-
## Using this component
71+
- [x] ~~LICENSE~~
72+
- [ ] Customizable colors
73+
- [ ] Write an article about the lib on Medium
5774

58-
### Script tag
5975

60-
- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)
61-
- Put a script tag similar to this `<script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.js'></script>` in the head of your index.html
62-
- Then you can use the element anywhere in your template, JSX, html etc
76+
## Author
6377

64-
### Node Modules
65-
- Run `npm install my-component --save`
66-
- Put a script tag similar to this `<script src='node_modules/my-component/dist/mycomponent.js'></script>` in the head of your index.html
67-
- Then you can use the element anywhere in your template, JSX, html etc
78+
FreakyCoder, kurayogun@gmail.com
79+
80+
## License
81+
82+
WebComponent Chmod Checkbox is available under the MIT license. See the LICENSE file for more info.
6883

69-
### In a stencil-starter app
70-
- Run `npm install my-component --save`
71-
- Add an import to the npm packages `import my-component;`
72-
- Then you can use the element anywhere in your template, JSX, html etc

0 commit comments

Comments
 (0)