Adding Components¶

Example adding a subtitle component

Register type definition and component mapping¶

All google sheet template rows are type-checked, and as such any new row types need to have their type definitions and component mappings registered.

packages\data-models\flowTypes.ts

export type TemplateRowType =
    | "subtitle"

src\app\shared\components\template\components\index.ts

import { TemplateSubtitleComponent } from "./subtitle";

export const TEMPLATE_COMPONENTS = [
  TemplateSubtitleComponent
]

export const TEMPLATE_COMPONENT_MAPPING = {
  subtitle: TemplateSubtitleComponent,

Create example template¶

There should ideally be at least two examples created, one with basic configuration and others showing the full range of parameter options

These can be authored in the components_demo google drive folder

Caution

The example sheet should be kept in draft state to avoid type-errors if merged into branches without type updates.

Instead just temporarily mark as released if needing to sync into local branch

Create documentation¶

All components should have documentation added to the documentation folder.

Follow authoring instructions in Adding Documentation and see demos in the local documentation/docs/components folder