flg-webcomponents-test v0.0.5
FLG Webcomponents
This is a project for a collection of webcomponents that will be used in Classic. Currently it will contain only one component - a slideout.
How this interacts with Classic
While running this project or initiating the build - a build folder is generated in /www
. We copy all the files inside /www
and move them inside FLG under public/js/flg-webcomponents
. So if you need to quickly test changes in the slideout in FLG and flg360-app
and this repo flg-webcomponents
are sibling directories you could run this command while inside the root of FLG.
rm -rf public/js/flg-webcomponents && cp -R ../flg-webcomponents/www/ public/js/flg-webcomponents
Quirks and bugs
When you create a functional component it is not converted into a webcomponent, it actually just gets transpiled to jsx see here.
When you are doing css you have to be careful with the url that gets referenced. In the
flg-slideout.tsx
component I'm using a background image
background-image: url(../images/svgs/search.svg), url(assets/svgs/search.svg);
the first url is actually for FLG. The url would actually look at http://<flg_domain>/images/svgs/search.svg
when used in FLG, the second url is a default one that references the assets folder in the src.
TODO
It would be nice to upgrade all the packages, but there was an issue in the rollup step when dealing with inline svg, so the packages have been shrinkwrapped for now(ever).
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 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.
Stencil components are just Web Components, so they work in any major framework or with no framework at all.
Getting Started
To start building a new web component using Stencil, clone this repo to a new directory:
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
and run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out our docs here.
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
Script tag
- Publish to NPM
- 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 - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm install my-component --save
- Put a script tag similar to this
<script src='node_modules/my-component/dist/mycomponent.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 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