Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 1.61 KB

use-meta.md

File metadata and controls

67 lines (50 loc) · 1.61 KB
Raw

useMeta

Adds getters to easily retrieve meta value.

Simply list at the top of your controller the list of meta name you need (static metaNames = [])

Getters are then automatically defined by the mixin.

  • Getter name is a camelized conversion of the meta name with an optional Meta suffix. user_id becomes userIdMeta
  • Values are automatically cast so getters return: String, Number, Boolean or Object

Options:

Option Description Default value
suffix prepend or not Meta to the getter name. Default is true to remain consistent with Value and Class API true

Example

useMeta(this, { suffix: false })

Usage

Composing

Given some html

<head>
  ...
  <meta name="userId" content="12345678">
  <meta name="admin" content="true">
  <meta name="email" content="joe@doe.com">
  <meta name="snake_case_name" content="are camelized">
  ...
</head>
import { Controller } from '@hotwired/stimulus'
import { useMeta } from 'stimulus-use'

export default class extends Controller {
  static metaNames = ['userId', 'admin', 'email', 'snake_case_name']

  connect() {
    useMeta(this)

    // individual getters
    this.userIdMeta         // 123456 -> Number
    this.adminMeta          // true -> Boolean
    this.emailMeta          // "joe@doe.com" -> String
    this.snakeCaseNameMeta  // "are camelized"

    // get all metas in one object
    this.metas
    // {
    //   userId: 123456,
    //   admin: true,
    //   email: "joe@doe.com",
    //   snakeCaseName: "are camelized"
    // }
  }
}