Référence rapide

Aide-mémoire Stencil.js

Guide de référence rapide pour le compilateur de Web Components Stencil.js : décorateurs, props, state, slots et cycle de vie.

· Publié le

Guide de démarrage rapide

Définition de composant

import { Component, Prop, State, h } from '@stencil/core'

@Component({
  tag: 'my-component',
  styleUrl: 'my-component.scss',
  shadow: true
})
export class MyComponent {
  @Prop() name: string
  @State() isVisible: boolean = true

  render() {
    return <p>I am {this.name}!</p>
  }
}
<my-component name="Groot"></my-component>

Gestion des événements DOM

export class MyComponent {
  inputChanged(event: UIEvent) {
    console.log('input changed:', (event.target as HTMLInputElement).value)
  }

  render() {
    return (
      <input onChange={(e: UIEvent) => this.inputChanged(e)} />
    )
  }
}

Retourner plusieurs nœuds enfants

render() {
  return [
    <h1>Hello there</h1>,
    <p>This component returns multiple root nodes</p>
  ]
}

Gestion de l état

Mettre à jour l état

export class MyComponent {
  @State() isVisible: boolean = false

  show() {
    this.isVisible = true
  }
}

Immuabilité pour tableaux et objets

Éviter les mutations directes

// Avoid in-place mutations
this.names.push('Larry')
this.options.show = true

Créer de nouvelles références pour déclencher le réaffichage

// Trigger re-render by assigning new instances
this.names = [...this.names, 'Larry']
this.options = { ...this.options, show: true }

Slots

Slot par défaut

<my-component>
  <span>Hello, friends</span>
</my-component>
render() {
  return <h1><slot /></h1>
}

Slots nommés

<my-component>
  <p slot="my-header">Header Content</p>
  <p slot="my-footer">Footer Content</p>
</my-component>
render() {
  return (
    <div>
      <header><slot name="my-header" /></header>
      <footer><slot name="my-footer" /></footer>
    </div>
  )
}

Hooks de cycle de vie

Hook de cycle de vie Moment / Description
componentWillLoad() Appelé une fois avant le premier rendu
componentDidLoad() Appelé une fois après le rendu initial
componentWillUpdate() Appelé avant le réaffichage suite à un changement de state/prop
componentDidUpdate() Appelé après la fin du réaffichage
disconnectedCallback() Appelé lorsque l élément est supprimé du DOM

Références

Sujets associés