my-adorable-message-comonent

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

#Creating a Collection of Web Components

Generating a Collection of Web Components - p314

npm init stencil

? Pick a starter › - Use arrow-keys. Return to submit.

ionic-pwa     Everything you need to build fast, production ready PWAs
app           Minimal starter for building a Stencil app or website
❯ component   Collection of web components that can be used anywhere

√ Pick a starter » component
√ Project name » component-collection

✔ All setup 🎉 in 64 ms

  > npm start
    Starts the development server.

  > npm run build
    Builds your components/app in production mode.

  > npm test
    Starts the test runner.


  We suggest that you begin by typing:

   > cd component-collection
   > npm start

  Further reading:

   - https://github.com/ionic-team/stencil-component-starter

  Happy coding! 🎈

Create a file (and folder) at src/components/my-adorable-message/myadorable- message.tsx

Create a file at src/components/my-adorable-message/my-adorablemessage.css

Modify src/components/my-adorable-message/my-adorable-message.tsx

import {Component, Prop, h} from "@stencil/core";

@Component({
  tag: "my-adorable-message",
  styleUrl: "my-adorable-message.css"
})

export class MyAdorableMessage {
  @Prop() author: string;
  @Prop() id: string;
  @Prop() side: string;

  render() {
    return (
      <div class={"message-container " + (this.side == "left" ? "fade-left" : "fade-right")}>
        <div class="avatar">
          <img src={`https://api.adorable.io/avatars/285/${this.id}`} alt="avatar-image"/>
        </div>
        <div>
          <div class="message">
            <slot />
          </div>
          <small class="author">{this.author}</small>
        </div>
      </div>
    )
  }
}

The DOM Function

@Component({
  tag: "my-adorable-message",
  styleUrl: "my-adorable-message.css"
  shadow: true
})

To enable the DOM function, add shadow: true to the Component. This will encapsulate the component in a Shadow DOM.

More information in the Basics section.

Modify the styling in my-adorable-message.css

@keyframes fade-in-left {
  from {
    opacity: 0;
    transform: translateX(-30px);
  }
  to {
    opacity: 1;
    transform: translateX(0);
  }
}

@keyframes fade-in-right {
  from {
    opacity: 0;
    transform: translateX(30px);
  }
  to {
    opacity: 1;
    transform: translateX(0);
  }
}

Keep modifying the css

.fade-right {
  animation: 1s fade-in-right forwards cubic-bezier(0.075, 0.82, 0.165, 1);
  animation-delay: 0.5s;
  flex-direction: row-reverse;
}

.fade-left {
  animation: 1s fade-in-left forwards cubic-bezier(0.075, 0.82, 0.165, 1);
  animation-delay: 0.5s;
}

Depending on the class, we apply either the fade-in-right or fade-in-left key frames

the cubicbezier defines the timing of the animation (e.g. the animation might play faster at the beginning, and slow at the end).

And still modifying the css

.message-container {
  opacity: 0;
  width: 100%;
  display: flex;
  margin: 20px 0;
}

.message {
  background-color: #f6f6f6;
  border-radius: 10px;
  padding: 20px;
  margin: 0 20px;
}

.author {
  color: #7d7d7d;
  font-style: italic;
  margin: 5px 20px;
}

.avatar img {
  height: auto;
  max-width: 50px;
  margin: 0 10px;
  border-radius: 50%;
}

.fade-right .author {
  float: left;
}

.fade-left .author {
  float: right;
}

Add the <my-adorable-message> tags to index-html

<my-adorable-message author="Josh" id="123123" side="right">
  Hello there
</my-adorable-message>

<my-adorable-message author="David" id="122122" side="left">
  Oh hey!
</my-adorable-message>

Start the application npm start

Publishing and Using a Collection of Web Components