Table of contents

• In action
• Overview
• Getting Started
  • Install
  • Add to a document
  • Add to a story
  • Insert into an MDX document
  • Configure props globally
• API
  • NotesBlock

In action

Example site

Overview

This addon contains a NotesBlock that you can integrate into any page, as well as a standalone NotesPage

Getting Started

Install

yarn add@component-controls/addon-notes --dev

Add to a document

The notes will be assigned to all the stories in the current document

in mystory.stories.tsx

import { Document } from '@component-controls/core';
import design_notes from './design-assets/design-notes.md';;


export default {
  title: 'MyStory',
  plugins: {
    notes: {
      title: 'Design brief',
      items: [design_notes],
    },
  },
} as Document;

Add to a story

The notes will be assigned only to a specific story. This allows multiple stories in the document to have different notes associated with them.

in mystory.stories.tsx

import React from 'react';
import { Document, Example } from '@component-controls/core';

export default {
  title: 'MyStory',
} as Document;

export const story: Example = () => <Button>click me</Button>;

story.design = {
  plugins: {
    notes: [
      # Introduction
      some **markdown**
    ],
  },
};

Insert into an MDX document

in mystory.mdx

---
title: MyStory
---
import { NotesBlock } from '@component-controls/addon-notes';

<NotesBlock
  items={[
      `
# Introduction
some **markdown**
`,
  ]}
/>

Configure props globally

You can globally change the default options of the NotesBlock component

in .config/runtime.tsx

import { RuntimeConfiguration } from "@component-controls/core";

const config: RuntimeConfiguration = {
  ...
  components: {
    notes: {
      title: 'Design files'
    }
  },
};

export default config;

API

NotesBlock

react component

defined in @component-controls/addon-notes/plugins/addon-notes/src/NotesBlock/NotesBlock.tsx

properties

| Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | items | ((string, type))[] | NotesBlockOwnProps | | | title | string | BlockContainerOwnProps | optional section title for the block. | | description | string | BlockContainerOwnProps | optional markdown description. | | id | string | BlockContainerOwnProps | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | collapsible | boolean | BlockContainerOwnProps | if false, will nothave a collapsible frame. | | data-testid | string | BlockContainerOwnProps | testing id | | plain | boolean | BlockContainerOwnProps | inner container variant or plain | | slot | string | undefined | HTMLAttributes | | | style | CSSProperties | undefined | HTMLAttributes | | | key | Key | null | undefined | Attributes | | | sx | ThemeUICSSObject | ThemeDerivedStyles | Attributes | The ThemeUIStyleObject extends [style props](https://emotion.sh/docs/object-styles) such that properties that are part of the Theme will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | defaultChecked | boolean | undefined | HTMLAttributes | | | defaultValue | string | number | ReadonlyArray<string> | undefined | HTMLAttributes | | | suppressContentEditableWarning | boolean | undefined | HTMLAttributes | | | suppressHydrationWarning | boolean | undefined | HTMLAttributes | | | accessKey | string | undefined | HTMLAttributes | | | className | string | undefined | HTMLAttributes | | | contentEditable | Booleanish | "inherit" | undefined | HTMLAttributes | | | contextMenu | string | undefined | HTMLAttributes | | | dir | string | undefined | HTMLAttributes | | | draggable | Booleanish | undefined | HTMLAttributes | | | hidden | boolean | undefined | HTMLAttributes | | | lang | string | undefined | HTMLAttributes | | | placeholder | string | undefined | HTMLAttributes | | | spellCheck | Booleanish | undefined | HTMLAttributes | | | tabIndex | number | undefined | HTMLAttributes | | | translate | "yes" | "no" | undefined | HTMLAttributes | | | radioGroup | string | undefined | HTMLAttributes | | | role | AriaRole | undefined | HTMLAttributes | | | about | string | undefined | HTMLAttributes | | | datatype | string | undefined | HTMLAttributes | | | inlist | any | HTMLAttributes | | | prefix | string | undefined | HTMLAttributes | | | property | string | undefined | HTMLAttributes | | | resource | string | undefined | HTMLAttributes | | | typeof | string | undefined | HTMLAttributes | | | vocab | string | undefined | HTMLAttributes | | | autoCapitalize | string | undefined | HTMLAttributes | | | autoCorrect | string | undefined | HTMLAttributes | | | autoSave | string | undefined | HTMLAttributes | | | color | string | undefined | HTMLAttributes | | | itemProp | string | undefined | HTMLAttributes | | | itemScope | boolean | undefined | HTMLAttributes | | | itemType | string | undefined | HTMLAttributes | | | itemID | string | undefined | HTMLAttributes | | | itemRef | string | undefined | HTMLAttributes | | | results | number | undefined | HTMLAttributes | | | security | string | undefined | HTMLAttributes | | | unselectable | "on" | "off" | undefined | HTMLAttributes | | | inputMode | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined | HTMLAttributes | Hints at the type of data that might be entered by the user while editing the element or its contents | | is | string | undefined | HTMLAttributes | Specify that a standard HTML element should behave like a defined custom built-in element | | aria-activedescendant | string | undefined | AriaAttributes | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | aria-atomic | boolean | "false" | "true" | undefined | AriaAttributes | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | aria-autocomplete | "none" | "inline" | "list" | "both" | undefined | AriaAttributes | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | aria-busy | boolean | "false" | "true" | undefined | AriaAttributes | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | aria-checked | boolean | "false" | "mixed" | "true" | undefined | AriaAttributes | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | aria-colcount | number | undefined | AriaAttributes | Defines the total number of columns in a table, grid, or treegrid. | | aria-colindex | number | undefined | AriaAttributes | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | aria-colspan | number | undefined | AriaAttributes | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | aria-controls | string | undefined | AriaAttributes | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | aria-current | boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined | AriaAttributes | Indicates the element that represents the current item within a container or set of related elements. | | aria-describedby | string | undefined | AriaAttributes | Identifies the element (or elements) that describes the object. | | aria-details | string | undefined | AriaAttributes | Identifies the element that provides a detailed, extended description for the object. | | aria-disabled | boolean | "false" | "true" | undefined | AriaAttributes | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | aria-dropeffect | "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined | AriaAttributes | Indicates what functions can be performed when a dragged object is released on the drop target. | | aria-errormessage | string | undefined | AriaAttributes | Identifies the element that provides an error message for the object. | | aria-expanded | boolean | "false" | "true" | undefined | AriaAttributes | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | aria-flowto | string | undefined | AriaAttributes | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | aria-grabbed | boolean | "false" | "true" | undefined | AriaAttributes | Indicates an element's "grabbed" state in a drag-and-drop operation. | | aria-haspopup | boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined | AriaAttributes | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | aria-hidden | boolean | "false" | "true" | undefined | AriaAttributes | Indicates whether the element is exposed to an accessibility API. | | aria-invalid | boolean | "false" | "true" | "grammar" | "spelling" | undefined | AriaAttributes | Indicates the entered value does not conform to the format expected by the application. | | aria-keyshortcuts | string | undefined | AriaAttributes | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | aria-label | string | undefined | AriaAttributes | Defines a string value that labels the current element. | | aria-labelledby | string | undefined | AriaAttributes | Identifies the element (or elements) that labels the current element. | | aria-level | number | undefined | AriaAttributes | Defines the hierarchical level of an element within a structure. | | aria-live | "off" | "assertive" | "polite" | undefined | AriaAttributes | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | aria-modal | boolean | "false" | "true" | undefined | AriaAttributes | Indicates whether an element is modal when displayed. | | aria-multiline | boolean | "false" | "true" | undefined | AriaAttributes | Indicates whether a text box accepts multiple lines of input or only a single line. | | aria-multiselectable | boolean | "false" | "true" | undefined | AriaAttributes | Indicates that the user may select more than one item from the current selectable descendants. | | aria-orientation | "horizontal" | "vertical" | undefined | AriaAttributes | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | aria-owns | string | undefined | AriaAttributes | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | aria-placeholder | string | undefined | AriaAttributes | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | aria-posinset | number | undefined | AriaAttributes | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | aria-pressed | boolean | "false" | "mixed" | "true" | undefined | AriaAttributes | Indicates the current "pressed" state of toggle buttons. | | aria-readonly | boolean | "false" | "true" | undefined | AriaAttributes | Indicates that the element is not editable, but is otherwise operable. | | aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals" | undefined | AriaAttributes | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | aria-required | boolean | "false" | "true" | undefined | AriaAttributes | Indicates that user input is required on the element before a form may be submitted. | | aria-roledescription | string | undefined | AriaAttributes | Defines a human-readable, author-localized description for the role of an element. | | aria-rowcount | number | undefined | AriaAttributes | Defines the tota