TitleInput
value type: string
The TitleInput
block can display a title, yet allow the user to click a edit icon and change the title. This is useful when the UI renders an existing document with a title, which a user must be able to edit.
Block
Click edit to change the title.
State
block_id: Click edit to change the title.
Block Setup
id: block_id
type: TitleInput
Settings
TitleInput JSON Schema Definition
type: object
properties:
events:
additionalProperties: false
properties:
onChange:
description: Trigger action when title is changed.
type: array
onCopy:
description: Trigger action when copy text is clicked.
type: array
onExpand:
description: Trigger action when ellipse expand is clicked.
type: array
type: object
properties:
additionalProperties: false
properties:
code:
default: false
description: Apply code style.
type: boolean
color:
description: Title color.
type: string
copyable:
default: false
oneOf:
- description: Provide copy text button.
type: boolean
- additionalProperties: false
properties:
icon:
description: >-
Copy icon, can be an array or two icons for before and after
clicked.
type:
- string
- object
- array
text:
description: Paragraph text to copy when clicked.
type: string
tooltips:
description: >-
Tooltip text, can be an array or two strings for before and
after clicked.
type:
- string
- array
type: object
delete:
default: false
description: Apply deleted (strikethrough) style.
type: boolean
disabled:
default: false
description: Apply disabled style.
type: boolean
editable:
default: true
oneOf:
- description: >-
Allow paragraph editing when true, editable settings can be provided
with editable object.
type: boolean
- additionalProperties: false
properties:
editing:
default: false
description: Control editing state.
type: boolean
icon:
description: Edit icon.
type:
- string
- object
maxLength:
description: Max length of text area input.
type: number
tooltip:
description: Edit tooltip text.
type: string
type: object
ellipsis:
default: false
oneOf:
- description: Display ellipsis when text overflows a single line.
type: boolean
- additionalProperties: false
properties:
expandable:
description: Expand hidden content when clicked.
type: boolean
rows:
description: Max rows of content.
type: number
suffix:
description: Suffix of ellipses content.
type: string
type: object
level:
default: 1
description: Set title type. Matches with h1, h2, h3 and h4.
enum:
- 1
- 2
- 3
- 4
type: number
mark:
default: false
description: Apply marked (highlighted) style.
type: boolean
type:
default: default
description: Additional types. Don't specify for default.
enum:
- default
- secondary
- warning
- danger
type: string
underline:
default: false
description: Apply underline style.
type: boolean
type: object