diff --git a/README.md b/README.md index b58d375..6e4fb20 100644 --- a/README.md +++ b/README.md @@ -780,6 +780,28 @@ interface CustomCodeComponent extends Node { - The basic interface in Spark to make reference to this system above (eg. the git repo URL or a public S3 bucket), and provide some data for it if necessary. This will be the Custom Component storyblock. - The data Spark receives from entering a specific ID will be used to render dynamic fields (the `attributes`). +### InNumbers + +```ts +/** + * A definition has a term and a related description. It is used to describe a term. + */ +interface Definition extends Node { + type: "definition" + term: string + description: string +} + +/** + * InNumbers represents a set of numbers with related descriptions. + */ +interface InNumbers extends Parent { + type: "in-numbers" + /** The title for the InNumbers */ + title?: string + children: [Definition, Definition, Definition] +} +``` ## License diff --git a/content-tree.d.ts b/content-tree.d.ts index 976cae8..8c89f23 100644 --- a/content-tree.d.ts +++ b/content-tree.d.ts @@ -285,6 +285,23 @@ export declare namespace ContentTree { /** Configuration data to be passed to the component. */ attributes: CustomCodeComponentAttributes; } + /** + * A definition has a term and a related description. It is used to describe a term. + */ + interface Definition extends Node { + type: "definition"; + term: string; + description: string; + } + /** + * InNumbers represents a set of numbers with related descriptions. + */ + interface InNumbers extends Parent { + type: "in-numbers"; + /** The title for the InNumbers */ + title?: string; + children: [Definition, Definition, Definition]; + } namespace full { type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | RecommendedList | Tweet | Video | YoutubeVideo | Text; type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width"; @@ -572,6 +589,23 @@ export declare namespace ContentTree { /** Configuration data to be passed to the component. */ attributes: CustomCodeComponentAttributes; } + /** + * A definition has a term and a related description. It is used to describe a term. + */ + interface Definition extends Node { + type: "definition"; + term: string; + description: string; + } + /** + * InNumbers represents a set of numbers with related descriptions. + */ + interface InNumbers extends Parent { + type: "in-numbers"; + /** The title for the InNumbers */ + title?: string; + children: [Definition, Definition, Definition]; + } } namespace transit { type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | RecommendedList | Tweet | Video | YoutubeVideo | Text; @@ -845,6 +879,23 @@ export declare namespace ContentTree { /** How the component should be presented in the article page according to the column layout system */ layoutWidth: LayoutWidth; } + /** + * A definition has a term and a related description. It is used to describe a term. + */ + interface Definition extends Node { + type: "definition"; + term: string; + description: string; + } + /** + * InNumbers represents a set of numbers with related descriptions. + */ + interface InNumbers extends Parent { + type: "in-numbers"; + /** The title for the InNumbers */ + title?: string; + children: [Definition, Definition, Definition]; + } } namespace loose { type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | RecommendedList | Tweet | Video | YoutubeVideo | Text; @@ -1133,5 +1184,22 @@ export declare namespace ContentTree { /** Configuration data to be passed to the component. */ attributes?: CustomCodeComponentAttributes; } + /** + * A definition has a term and a related description. It is used to describe a term. + */ + interface Definition extends Node { + type: "definition"; + term: string; + description: string; + } + /** + * InNumbers represents a set of numbers with related descriptions. + */ + interface InNumbers extends Parent { + type: "in-numbers"; + /** The title for the InNumbers */ + title?: string; + children: [Definition, Definition, Definition]; + } } }