@aiconomy/aico-components 0.0.14 → 0.0.57

package/README.md

@@ -1,75 +1,85 @@
-[![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)](https://stenciljs.com)
-
-# Stencil Component Starter
-
-This is a starter project for building a standalone Web Component using Stencil.
-
-Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.
-
-# Stencil
-
-Stencil is a compiler for building fast web apps using Web Components.
-
-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.
+# @aiconomy/aico-components
 
-Stencil components are just Web Components, so they work in any major framework or with no framework at all.
+[![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)](https://stenciljs.com)
 
-## Getting Started
+## Example usage
 
-To start building a new web component using Stencil, clone this repo to a new directory:
+Use the components as plain HTML tags:
 
-```bash
-git clone https://github.com/ionic-team/stencil-component-starter.git my-component
-cd my-component
-git remote rm origin
+```html
+<aico-news-list aico-url="<your-api-url>" aico-bearer-token="<your-api-token>"></aico-news-list>
 ```
 
-and run:
-
-```bash
-npm install
-npm start
-```
+## Using these components
 
-To build the component for production, run:
+There are three strategies we recommend for using web components built with Stencil.
 
-```bash
-npm run build
-```
+### Script tag
 
-To run the unit tests for the components, run:
+- Put the following tags in the head of your `index.html`:
 
-```bash
-npm test
+```html
+<link rel="stylesheet" href="https://unpkg.com/@aiconomy/aico-components@<version>/dist/aico-components/aico-components.css" />
+<script type="module" src="https://unpkg.com/@aiconomy/aico-components@<version>/dist/aico-components/aico-components.esm.js"></script>
+<script nomodule src="https://unpkg.com/@aiconomy/aico-components@<version>/dist/esm/aico-components.js"></script>
 ```
 
-Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
+- Then you can use the elements anywhere in your template, JSX, html etc
 
+### Node Modules
 
-## Naming Components
-
-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!
-
-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`.
-
-
-## Using this component
-
-There are three strategies we recommend for using web components built with Stencil.
-
-The first step for all three of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-### Script tag
+- Run `npm i @aiconomy/aico-components`
+- Put the following tags in the head of your `index.html`:
 
-- Put a script tag similar to this `<script type='module' src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script>` in the head of your index.html
-- Then you can use the element anywhere in your template, JSX, html etc
+```html
+<link rel="stylesheet" href="https://unpkg.com/@aiconomy/aico-components@<version>/dist/aico-components/aico-components.css" />
+<script type="module" src="https://unpkg.com/@aiconomy/aico-components@<version>/dist/aico-components/aico-components.esm.js"></script>
+<script nomodule src="https://unpkg.com/@aiconomy/aico-components@<version>/dist/esm/aico-components.js"></script>
+```
 
-### Node Modules
-- Run `npm install my-component --save`
-- Put a script tag similar to this `<script type='module' src='node_modules/my-component/dist/my-component.esm.js'></script>` in the head of your index.html
-- Then you can use the element anywhere in your template, JSX, html etc
+- Then you can use the elements anywhere in your template, JSX, html etc
 
 ### In a stencil-starter app
-- Run `npm install my-component --save`
-- Add an import to the npm packages `import my-component;`
-- Then you can use the element anywhere in your template, JSX, html etc
+
+- Run `npm i @aiconomy/aico-components`
+- Add an import to the npm packages `import needed-aico-component;`
+- Then you can use the elements anywhere in your template, JSX, html etc
+
+## Listening to element
+
+Please check out [Stencil's documentation](https://stenciljs.com/docs/events#listening-to-events-from-a-non-jsx-element).
+
+## Aiconomy components
+
+### Primary components
+
+- [aico-article-detail](/src/components/aico-article-detail/readme.md)
+- [aico-fetch-article-detail](/src/components/aico-fetch-article-detail/readme.md)
+- [aico-news-list](/src/components/aico-news-list/readme.md)
+- [aico-news-list-item](/src/components/aico-news-list-item/readme.md)
+- [aico-special-news-carousel](/src/components/aico-special-news-carousel/readme.md)
+
+### Secondary components
+
+These are used by the [aico-article-detail](/src/components/aico-article-detail/readme.md) component to be able to render the article's content.
+
+- [aico-album-content](/src/components/content/aico-album-content/readme.md)
+- [aico-asking-content](/src/components/content/aico-asking-content/readme.md)
+- [aico-block-quote-content](/src/components/content/aico-block-quote-content/readme.md)
+- [aico-bullet-content](/src/components/content/aico-bullet-content/readme.md)
+- [aico-carousel-content](/src/components/content/aico-carousel-content/readme.md)
+- [aico-content-card-content](/src/components/content/aico-content-card-content/readme.md)
+- [aico-divider-content](/src/components/content/aico-divider-content/readme.md)
+- [aico-document-content](/src/components/content/aico-document-content/readme.md)
+- [aico-faq-content](/src/components/content/aico-faq-content/readme.md)
+- [aico-heading-content](/src/components/content/aico-heading-content/readme.md)
+- [aico-html-content](/src/components/content/aico-html-content/readme.md)
+- [aico-link-content](/src/components/content/aico-link-content/readme.md)
+- [aico-news-content](/src/components/content/aico-news-content/readme.md)
+- [aico-page-content](/src/components/content/aico-page-content/readme.md)
+- [aico-table-content](/src/components/content/aico-table-content/readme.md)
+- [aico-testimonial-content](/src/components/content/aico-testimonial-content/readme.md)
+- [aico-text-content](/src/components/content/aico-text-content/readme.md)
+- [aico-title-content](/src/components/content/aico-title-content/readme.md)
+- [aico-upload-content](/src/components/content/aico-upload-content/readme.md)
+- [aico-video-content](/src/components/content/aico-video-content/readme.md)