@jdecode-dev/jdecode-ui v0.0.12-beta

Jdecode UI :wrench:

:warning: IMPORTANT! Jdecode UI is under construction and may have some issues

I do not recommend use/install this Library until it is finished. Hope will be soon.

Jdecode UI

Jdecode UI is a framework-agnostic collection of UI components.

This components are build using Stencil. To know more about Stencil, here you have Stencil Documentation.

1. Install Components

From GIT:

To use this components, simply download or clone the repository.

You can clone the repository using this comands in your terminal:

git clone https://github.com/jdecode-dev/jdecode-ui.git jdecode-ui
cd jdecode-ui

After that, run the following commands to get it up and running:

Use NPM or YARN:

npm install
npm start

yarn 
yarn start

From NPM:

This library is published as a package in npm. Check the package link: @jdecode-dev/jdecode-ui.

To use the components in your project, you have 3 options:

I. Script tag

Put a script tag: in the of your index.html

*Important: The X.X.X is the specific version of the library, you should use specifc versions to prevent against breaking changes.

For options II and III you must install from NPM:

You can install the package from NPM. Simply run this comand:

npm i @jdecode-dev/jdecode-ui --save

II. Node Modules

Put a script tag similar to this in the of your index.html

III. In a stencil-starter app

Add this line in your index.ts:

import '@jdecode-dev/jdecode-ui'

After you can use the element anywhere in your template, JSX, html etc

2. Use Components

Inside 'index.html' you will find samples of all the components that you can use.

3. Modify Components

You will need a SCSS compiler, you can use this comand to install SASS:

yarn add --dev @stencil/sass

or:

npm install -g sass

To view the components, you can use the index.html page.

To see your changes, use this line:

npm run start

4. Share your modified Components

After your modifications, you can build your components for production:

npm run build

Inside 'dist/' folder you will have all your components compiled and ready to share.