Component content from JSDocs

[PtitBen]

Outcome

We pull content automatically from the components' codebase into the documentation.

Scope

The following content blocks:

• Name
• Main purpose
• Specifications
• Events
• Permitted tags for slot
• Component placement - list of components
• Component display name
• Component categories [Form, Experience]
• Component flags [internal, deprecated]

[MekalaNagarajan-Centrica]

Permitted Tags

Jsdoc and web component analyzer support permitted tags for a slot as shown below.

When the custom elements are analysed and transformed into JSON format, the permitted tags are not included.

  "slots": [
    {
      "name": "heading",
      "description": "The heading of the accordion."
    },
    {
      "description": "Anonymous slot for expanders."
    }
  ]

[MekalaNagarajan-Centrica]

PR to pull permitted tag names and component placements centrica-engineering/muon#571

"slots": [
  {
    "name": "label",
    "description": "The label for the input.",
    "permittedTagNames": [
      "label"
    ]
  },
  {
    "description": "The form element passed in such as input, select, textarea.",
    "permittedTagNames": [
      "input",
      "select"
    ]
  },
  {
    "name": "tip-details",
    "description": "The tip details related to the helper.",
    "permittedTagNames": [
      "div"
    ]
  }
],
"placements": [
  "muon-form"
 ]

[MekalaNagarajan-Centrica]

Muon PR to split analyzer and json transformation centrica-engineering/muon#572

[MekalaNagarajan-Centrica]

Nucleus changes

• jsdoc slots https://github.com/ConnectedHomes/nucleus/pull/3313
• Rollup plugin to build custom elements jsdoc slots and placements https://github.com/ConnectedHomes/nucleus/pull/3316

[MekalaNagarajan-Centrica]

jsdoc slots in nucleus docs #269

[MekalaNagarajan-Centrica]

PR to update jsdoc https://github.com/ConnectedHomes/nucleus/pull/3333. This includes

• Component display name
• Component category
• Component internal flag

[MekalaNagarajan-Centrica]

Update sidebar using jsdoc #292

[MekalaNagarajan-Centrica]

This ticket can be closed as the below work are moved to individual tickets.
@placement updation is moved to #364
description updation is moved to #363