Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.11 KB

PACKAGE_FEATURE_README_TEMPLATE.md

File metadata and controls

42 lines (30 loc) · 1.11 KB

Name of Block

Please provide a 1-2 sentence description of what the block is and what it does.

// TODO: add badge for passing/failing tests

Acceptance Criteria

  • Add AC relevant to the block

Props

Prop Required Type Descripton
required prop yes
optional prop no
contentConfig example Please specify which content sources are compatible

ANS Schema

Outline any schema information requirements necessary to know for ths block

ANS Fields

  • Add all ANS fields used in the block

Internationalization fields

Phrase key Default (English)
key english translation

Events

Blocks can emit events. The following is a list of events that are emitted by this block.

Event Name Description
eventName Describe the event

Event Listening

Include block specific intructions for event listening.

OR

This block does not emit any events.

Additional Considerations

This is optional. Please add an additional context that would be important to know in order to use this block.