interface SectionalElementProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.AmplifyUIBuilder.CfnForm.SectionalElementProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnForm_SectionalElementProperty |
Java | software.amazon.awscdk.services.amplifyuibuilder.CfnForm.SectionalElementProperty |
Python | aws_cdk.aws_amplifyuibuilder.CfnForm.SectionalElementProperty |
TypeScript | aws-cdk-lib » aws_amplifyuibuilder » CfnForm » SectionalElementProperty |
The SectionalElement property specifies the configuration information for a visual helper element for a form.
A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplifyuibuilder as amplifyuibuilder } from 'aws-cdk-lib';
const sectionalElementProperty: amplifyuibuilder.CfnForm.SectionalElementProperty = {
type: 'type',
// the properties below are optional
excluded: false,
level: 123,
orientation: 'orientation',
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
text: 'text',
};
Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of sectional element. |
| excluded? | boolean | IResolvable | Excludes a sectional element that was generated by default for a specified data model. |
| level? | number | Specifies the size of the font for a Heading sectional element. |
| orientation? | string | Specifies the orientation for a Divider sectional element. |
| position? | IResolvable | Field | Specifies the position of the text in a field for a Text sectional element. |
| text? | string | The text for a Text sectional element. |
type
Type:
string
The type of sectional element.
Valid values are Heading , Text , and Divider .
excluded?
Type:
boolean | IResolvable
(optional)
Excludes a sectional element that was generated by default for a specified data model.
level?
Type:
number
(optional)
Specifies the size of the font for a Heading sectional element.
Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation?
Type:
string
(optional)
Specifies the orientation for a Divider sectional element.
Valid values are horizontal or vertical .
position?
Type:
IResolvable | Field
(optional)
Specifies the position of the text in a field for a Text sectional element.
text?
Type:
string
(optional)
The text for a Text sectional element.

.NET
Go
Java
Python
TypeScript