structured-render - v2.17.1
Preparing search index...
createAllStructuredRenderSectionShapes
Function createAllStructuredRenderSectionShapes
createAllStructuredRenderSectionShapes
<
IconKey
extends
string
>
(
iconShape
:
UnsafeShape
<
StructuredRenderIcon
<
IconKey
>
>
,
)
:
readonly
[
UnsafeShape
<
SharedSectionTypes
<
"collapsible"
>
&
{
content
:
(
|
StructuredRenderIcon
<
IconKey
>
|
RenderDataMarkdown
|
StructuredRenderCodeBlock
|
StructuredRenderEmpty
|
StructuredRenderInlineCode
|
StructuredRenderTag
|
StructuredRenderProcessing
|
StructuredRenderList
<
IconKey
>
|
StructuredRenderTable
<
IconKey
>
|
StructuredRenderText
<
IconKey
>
)
[]
;
header
:
Primitive
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"markdown"
>
&
{
markdown
:
string
}
>
,
UnsafeShape
<
SharedSectionTypes
<
"codeBlock"
>
&
{
code
:
string
;
syntax
?:
string
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"copyCard"
>
&
{
disableCopy
?:
boolean
|
null
;
header
?:
Primitive
;
text
:
Primitive
;
}
,
>
,
UnsafeShape
<
StructuredRenderEmpty
>
,
UnsafeShape
<
SharedSectionTypes
<
"title"
>
&
{
icon
?:
StructuredRenderIcon
<
IconKey
>
|
null
;
text
?:
Primitive
;
}
,
>
,
UnsafeShape
<
StructuredRenderIcon
<
IconKey
>
>
,
UnsafeShape
<
SharedSectionTypes
<
"inlineCode"
>
&
{
code
:
string
}
>
,
UnsafeShape
<
SharedSectionTypes
<
"list"
>
&
{
items
:
StructuredRenderListItem
<
IconKey
>
[]
;
}
,
>
,
UnsafeShape
<
StructuredRenderProcessing
>
,
UnsafeShape
<
StructuredRenderSource
>
,
UnsafeShape
<
SharedSectionTypes
<
"table"
>
&
{
direction
:
StructuredRenderCellDirection
;
entries
:
{
data
:
Record
<
string
,
|
StructuredRenderShapesAllowedInTable
<
(...)
>
|
null
|
undefined
|
((...)
|
(...)
|
(...))
[]
,
>
;
sources
?:
(
StructuredRenderSource
|
null
|
undefined
)
[]
|
null
;
}
[]
;
footerRows
?:
|
{
alignment
?:
StructuredRenderTableFooterAlignment
|
null
;
cells
:
|
StructuredRenderShapesAllowedInTable
<
IconKey
>
|
(StructuredRenderShapesAllowedInTable<IconKey> | null | undefined)
[]
|
null
|
undefined
;
}
[]
|
null
;
headers
:
{
disableSort
?:
boolean
|
null
;
hidden
?:
boolean
|
null
;
key
:
string
;
sortKey
?:
string
|
null
;
text
?:
StructuredRenderText
<
IconKey
>
|
null
;
}
[]
;
style
?:
StructuredRenderTextStyle
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"tag"
>
&
{
color
?:
|
{
custom
:
{
backgroundColor
?:
string
|
null
;
foregroundColor
?:
string
|
null
;
}
;
}
|
{
variant
:
ViraColorVariant
}
|
null
;
text
:
Primitive
;
useBigTag
?:
boolean
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"text"
>
&
{
icon
?:
StructuredRenderIcon
<
IconKey
>
|
null
;
style
?:
StructuredRenderTextStyle
|
null
;
text
?:
Primitive
;
}
,
>
,
]
Creates all structured render section shapes with the given icon shape.
Type Parameters
IconKey
extends
string
Parameters
iconShape
:
UnsafeShape
<
StructuredRenderIcon
<
IconKey
>
>
Returns
readonly
[
UnsafeShape
<
SharedSectionTypes
<
"collapsible"
>
&
{
content
:
(
|
StructuredRenderIcon
<
IconKey
>
|
RenderDataMarkdown
|
StructuredRenderCodeBlock
|
StructuredRenderEmpty
|
StructuredRenderInlineCode
|
StructuredRenderTag
|
StructuredRenderProcessing
|
StructuredRenderList
<
IconKey
>
|
StructuredRenderTable
<
IconKey
>
|
StructuredRenderText
<
IconKey
>
)
[]
;
header
:
Primitive
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"markdown"
>
&
{
markdown
:
string
}
>
,
UnsafeShape
<
SharedSectionTypes
<
"codeBlock"
>
&
{
code
:
string
;
syntax
?:
string
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"copyCard"
>
&
{
disableCopy
?:
boolean
|
null
;
header
?:
Primitive
;
text
:
Primitive
;
}
,
>
,
UnsafeShape
<
StructuredRenderEmpty
>
,
UnsafeShape
<
SharedSectionTypes
<
"title"
>
&
{
icon
?:
StructuredRenderIcon
<
IconKey
>
|
null
;
text
?:
Primitive
;
}
,
>
,
UnsafeShape
<
StructuredRenderIcon
<
IconKey
>
>
,
UnsafeShape
<
SharedSectionTypes
<
"inlineCode"
>
&
{
code
:
string
}
>
,
UnsafeShape
<
SharedSectionTypes
<
"list"
>
&
{
items
:
StructuredRenderListItem
<
IconKey
>
[]
;
}
,
>
,
UnsafeShape
<
StructuredRenderProcessing
>
,
UnsafeShape
<
StructuredRenderSource
>
,
UnsafeShape
<
SharedSectionTypes
<
"table"
>
&
{
direction
:
StructuredRenderCellDirection
;
entries
:
{
data
:
Record
<
string
,
|
StructuredRenderShapesAllowedInTable
<
(...)
>
|
null
|
undefined
|
((...)
|
(...)
|
(...))
[]
,
>
;
sources
?:
(
StructuredRenderSource
|
null
|
undefined
)
[]
|
null
;
}
[]
;
footerRows
?:
|
{
alignment
?:
StructuredRenderTableFooterAlignment
|
null
;
cells
:
|
StructuredRenderShapesAllowedInTable
<
IconKey
>
|
(StructuredRenderShapesAllowedInTable<IconKey> | null | undefined)
[]
|
null
|
undefined
;
}
[]
|
null
;
headers
:
{
disableSort
?:
boolean
|
null
;
hidden
?:
boolean
|
null
;
key
:
string
;
sortKey
?:
string
|
null
;
text
?:
StructuredRenderText
<
IconKey
>
|
null
;
}
[]
;
style
?:
StructuredRenderTextStyle
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"tag"
>
&
{
color
?:
|
{
custom
:
{
backgroundColor
?:
string
|
null
;
foregroundColor
?:
string
|
null
;
}
;
}
|
{
variant
:
ViraColorVariant
}
|
null
;
text
:
Primitive
;
useBigTag
?:
boolean
|
null
;
}
,
>
,
UnsafeShape
<
SharedSectionTypes
<
"text"
>
&
{
icon
?:
StructuredRenderIcon
<
IconKey
>
|
null
;
style
?:
StructuredRenderTextStyle
|
null
;
text
?:
Primitive
;
}
,
>
,
]
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
structured-render - v2.17.1
Loading...
Creates all structured render section shapes with the given icon shape.