@debtcollective/dc-header-component

Header

This is a Web component built using Stencil to define the header for all debtcollective web apps.

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

For header to have the dynamic variables you need to cp .env.sample .env then simple run.

npm install
npm start

In order to have a sense over the community session, you need to have the application running and make sure COMMUNITY_URL variable match the application (is set to localhost port 3000 by default). Ultimately, you will need to allow CORS on the community app in that sense: Admin > Settings > CORS > add http://lvh.me:3333

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

You can render the default styles with links you pass as props like:

<dc-header links='[{"href":"http://debtcollective.org/","text":"About us"}, {"href":"https://community.debtcollective.org/","text":"Community"}, {"href":"https://teespring.com/stores/debt-collective","text":"Store"}]'></dc-header>

Alternatively, you can choose to inject your own structure by doing something like:

<dc-header>
  <div slot="header">
    <div class="nav-item d-md-flex">
      <a class="nav-link" href='http://debtcollective.org/'>
        About us
      </a>
    </div>
  </div>
  <div slot="menu">
    <div class="nav-item">
      <a class="nav-link" href='http://debtcollective.org/'>
        About us (Just menu)
      </a>
    </div>
  </div>
</dc-header>

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