@rramsey/csi-brand-header NPM

Package Name: @rramsey/csi-brand-header

Skip to Angular Standalone Instructions

Skip to Angular Module Instructions

Stylable ::part elements

logo-div -- div containing the logo. div.logo.logo--tab or div.logo.logo--tab.with-tab
svg-div -- div that contains the svg. div.flex-row.center
svg-anchor -- the anchor that wraps around the svg element.
svg-elem -- the actual svg element
site-name -- the h1 containing the site name
site-anchor -- the anchor within the h1

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 csi-brand-header
cd csi-brand-header
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

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.

Script tag

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

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

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

Using This Component in a Standalone Angular Application

Generate the angular component with ng new --standalone APP-NAME
Answer the questions and install any other packages as you normally would
Install the component as you normally would with npm install --save THIS-COMPONENT
Open app.component.ts and import the CUSTOM_ELEMENTS_SCHEMA import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
Add CUSTOM_ELEMENTS_SCHEMA as a schema in the @Component decorator, for example
```
schemas: [CUSTOM_ELEMENTS_SCHEMA],
```
~~5. Open your main.ts file and import this component, import { THIS-COMPONENT} from "path/to/component";~~
Import defineCustomElements in your main.ts, import {defineCustomElements} from "path/to/loader";
HINT: It will be easier if you let your IDE complete the path
In main.ts, add the following line after the bootstrap command: defineCustomElements(window);
Now you should be able to add the element in any html file in your application with <component-selector></component-selector>

Using This Component in a Module based (non-Standalone) Application

Generate the angular component with ng new APP-NAME
Answer the questions and install any other packages as you normally would
Install the component as you normally would with npm install --save THIS-COMPONENT
Open app.module.ts and import the CUSTOM_ELEMENTS_SCHEMA import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
Add CUSTOM_ELEMENTS_SCHEMA as a schema in the @NgModule decorator, for example
```
imports: [ BrowserModule ],
providers: [],
bootstrap: [AppComponent],
schemas: [CUSTOM_ELEMENTS_SCHEMA],
exports: [ ]
```
~~5. Open your main.ts file and import this component, import { THIS-COMPONENT} from "path/to/component";~~
Import defineCustomElements in your main.ts, import {defineCustomElements} from "path/to/loader";
HINT: It will be easier if you let your IDE complete the path
In main.ts, add the following line after the bootstrap command: defineCustomElements(window);
Now you should be able to add the element in any html file in your application with <component-selector></component-selector>