Skip to main content

Interface: BlockGroupWithStatus

Represents a group of blocks with their selection status.

This interface extends the basic BlockGroup with additional information about the current selection state, including whether all required options have been selected.

Block groups organize related configuration options together, providing a logical structure to the product configuration process and improving the user experience.

Extends​

Properties​

autoNumbering​

autoNumbering: boolean

If true, groups will be automatically numbered.

Inherited from​

GroupsPreview.autoNumbering

groupIndex?​

optional groupIndex: number

Display order of this group relative to other groups.

Inherited from​

BlockGroup.groupIndex

hasErrors​

hasErrors: boolean

true if there are missing required selections in this group. This can be used to highlight incomplete sections in the UI.

When true, the group needs attention from the user to complete the configuration. UIs typically highlight groups with errors using color indicators or icons.

hideOnSpecification?​

optional hideOnSpecification: boolean

If true, this group should be hidden in the specification view.

Some groups contain technical or internal options that aren't relevant to the customer specification document, and should therefore be excluded.

id​

id: string

Unique identifier for this group.

Inherited from​

BlockGroup.id

name​

name: string

Display name for this group.

Inherited from​

BlockGroup.name

optionSetIds​

optionSetIds: string[]

List of option set IDs that belong to this group.

Inherited from​

BlockGroup.optionSetIds

optionSetNames​

optionSetNames: string

Comma-separated list of option set names in this group.

Inherited from​

BlockGroup.optionSetNames

preview?​

optional preview: BlockGroupPreview

Preview image settings for this group.

Inherited from​

BlockGroup.preview

selectMatching​

selectMatching: boolean

If true, selecting one option in the group will attempt to select matching options in other blocks of the same group.

Inherited from​

BlockGroup.selectMatching

values​

values: BlockSelectedValue[]

List of all selected values for all visible blocks in this group. Each entry contains the block name and the selected option value(s).

This provides a complete view of what options are currently selected within this group, making it easy to display summaries or validate completeness.

withDescription​

withDescription: boolean

If true, group descriptions will be displayed.

Inherited from​

GroupsPreview.withDescription

withPreviewImage​

withPreviewImage: boolean

If true, preview images will be shown for groups.

Inherited from​

GroupsPreview.withPreviewImage