Skip to content

Module Reference / @tinystacks/ops-core-widgets / Markdown

Interface: Markdown

@tinystacks/ops-core-widgets.Markdown

Example

SmallMarkdown:
   type: Markdown
   displayName: Small Markdown Window
   markdown: |
     ### This is fully supported markdown

     \`\`\`
     You can even drop in some code if you want
     \`\`\`

Hierarchy

↳ Markdown

Table of contents

Properties

Properties

additionalProperties

• Optional additionalProperties: any

Inherited from

Widget.additionalProperties

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:30

childrenIds

• Optional childrenIds: string[]

Inherited from

Widget.childrenIds

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:18

description

• Optional description: string

Inherited from

Widget.description

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:19

displayName

• displayName: string

A human-readable display name, usually used to title a widget

Inherited from

Widget.displayName

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:12

displayOptions

• Optional displayOptions: Object

Type declaration

Name Type Description
showDescription? boolean Whether to show the description
showDisplayName? boolean Whether to show the display name

Inherited from

Widget.displayOptions

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:20

id

• id: string

Unique Id for this widget.

Inherited from

Widget.id

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:8

markdown

• markdown: string

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:121

providerIds

• Optional providerIds: string[]

Inherited from

Widget.providerIds

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:17

type

• type: string

This describes how this widget should be rendered. The "type" should be equivalent to the Object definition's name of the widget you are trying to render.

Inherited from

Widget.type

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:16