Datepicker
🚧 This documentation is a work in progress.
Usage
Anatomy
+
Properties
Required properties: id
, type
, basicDataModelBindings.simpleBinding
Property | Type | Description |
---|---|---|
id | string | The component ID. Must be unique within all layouts/pages in a layout-set. Cannot end with dash or number. |
type | string | The component type. |
basicDataModelBindings | object | Data model bindings for the component |
basicDataModelBindings.simpleBinding | string | Data model binding for a component’s connection to a single field in the data model |
basicTextResources | object | Text resource bindings for a component. |
basicTextResources.title | string | The title/label text for the component |
basicTextResources.description | string | The description text for the component |
basicTextResources.help | string | The help text for the component |
basicTextResources.shortName | string | The short name for the component (used in validation messages) (optional). If it is not specified, ’title’ text is used. |
basicTextResources.tableTitle | string | The text shown in column title when component is used in repeating group (optional). If it is not specified, ’title’ text is used. |
required | boolean | Boolean or expression indicating if the component is required when filling in the form. Defaults to false. |
readOnly | boolean | Boolean or expression indicating if the component should be presented as read only. Defaults to false. Please note that even with read-only fields in components, it may currently be possible to update the field by modifying the request sent to the API or through a direct API call. |
format | string | Long date format used when displaying the date to the user. The user date format from the locale will be prioritized over this setting. Example(s): DD/MM/YYYY,MM/DD/YYYY,YYYY-MM-DD |
grid | object | Settings for the components grid. Used for controlling horizontal alignment. Example(s): {xs: 12} |
grid.innerGrid | gridProps | Optional grid for inner component content like input field or dropdown. Used to avoid inner content filling the component width. Example(s): {xs: 12} See: gridProps |
grid.labelGrid | gridProps | Optional grid for the component label. Used in combination with innerGrid to align labels on the side. Example(s): {xs: 12} See: gridProps |
hidden | boolean | Boolean value or expression indicating if the component should be hidden. Defaults to false. |
maxDate | string | Sets the maximum allowed date. Can also use keywords today , yesterday , tomorrow , oneYearFromNow and oneYearAgo to define a maximum date based on the current date. Defaults to 2100-01-01T12:00:00.000Z. |
minDate | string | Sets the minimum allowed date. Can also use keywords today , yesterday , tomorrow , oneYearFromNow and oneYearAgo to define a minimum date based on the current date. Defaults to 1900-01-01T12:00:00.000Z. |
pageBreak | object | Enables page break settings in PDF output. |
pageBreak.breakAfter | string | PDF only: Indicates whether a page break should be added after the component. Allowed values: auto (default), always , avoid . |
pageBreak.breakBefore | string | PDF only: Indicates whether a page break should be added before the component. Allowed values: auto (default), always , avoid . |
renderAsSummary | boolean | Boolean or expression indicating if the component should be rendered as a summary. Defaults to false. |
timeStamp | boolean | Boolean value indicating if the date time should be stored as a timeStamp. Defaults to true. If true: YYYY-MM-DDThh:mm:ss.sssZ , if false YYYY-MM-DD ; |
Configuration
We are currently updating Altinn Studio Designer with more configuration options!
The documentation is continuously updated, and there may be more settings available than what is described here, and some settings may be in beta version.
Add component
You can add a component in Altinn Studio Designer by dragging it from the list of components to the page area.
Selecting the component brings up its configuration panel.
Basic component:
App/ui/layouts/{page}.json
{
"$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layout.schema.v1.json",
"data": {
"layout": [
{
// Basic component (required properties)
}
]
}
}
}