Skip to content

InNumbers component interface #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

InNumbers component interface #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
627f722
InNumbers component interface
umbobabo Oct 8, 2025
18e76eb
feat: optional title
umbobabo Nov 5, 2025
3ba073b
Update TypeScript definition file
umbobabo Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
68 changes: 68 additions & 0 deletions content-tree.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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];
}
}
}