Skip to content

[WC-3077] CheckboxRadio: Enhance properties #1923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[WC-3077] CheckboxRadio: Enhance properties #1923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/pluggableWidgets/checkbox-radio-selection-web/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Added

- Added aria-label property

### Changed

- The Caption property now appears below Entity.
- The Caption property is now only visible if Custom content is set to 'No'.
- Moved the Group name attribute to the General tab in the General property group.

## [1.0.0] - 2025-08-25

### Added
Expand Down
16 changes: 16 additions & 0 deletions .../pluggableWidgets/checkbox-radio-selection-web/src/CheckboxRadioSelection.editorConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,22 @@ export function getProperties(
});
}

if (values.optionsSourceCustomContentType === "yes") {
if (values.source === "context" && values.optionsSourceType === "association") {
hidePropertiesIn(defaultProperties, values, [
"optionsSourceAssociationCaptionType",
"optionsSourceAssociationCaptionAttribute",
"optionsSourceAssociationCaptionExpression"
]);
} else if (values.source === "database") {
hidePropertiesIn(defaultProperties, values, [
"optionsSourceDatabaseCaptionType",
"optionsSourceDatabaseCaptionAttribute",
"optionsSourceDatabaseCaptionExpression"
]);
}
}

return defaultProperties;
}

Expand Down
86 changes: 45 additions & 41 deletions packages/pluggableWidgets/checkbox-radio-selection-web/src/CheckboxRadioSelection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,44 @@
</selectionTypes>
</property>
</propertyGroup>
<propertyGroup caption="Store value">
<property key="optionsSourceDatabaseValueAttribute" type="attribute" dataSource="optionsSourceDatabaseDataSource">
<caption>Value</caption>
<description />
<attributeTypes>
<attributeType name="String" />
<attributeType name="Integer" />
<attributeType name="Long" />
<attributeType name="Enum" />
</attributeTypes>
</property>
<property key="databaseAttributeString" type="attribute" setLabel="true" required="false">
<caption>Target attribute</caption>
<description />
<attributeTypes>
<attributeType name="String" />
<attributeType name="Integer" />
<attributeType name="Long" />
<attributeType name="Enum" />
</attributeTypes>
</property>
</propertyGroup>
<!-- END DATABASE / STRING -->
<propertyGroup caption="Attribute">
<!-- ASSOCIATION -->
<property key="attributeAssociation" type="association" selectableObjects="optionsSourceAssociationDataSource" required="true" setLabel="true">
<caption>Entity</caption>
<description />
<associationTypes>
<associationType name="Reference" />
<associationType name="ReferenceSet" />
</associationTypes>
</property>
<property key="optionsSourceAssociationDataSource" type="datasource" isList="true" required="false">
<caption>Selectable objects</caption>
<description />
</property>
</propertyGroup>
<propertyGroup caption="Caption">
<!-- CAPTIONS -->
<property key="optionsSourceAssociationCaptionType" type="enumeration" defaultValue="attribute">
Expand Down Expand Up @@ -103,44 +141,6 @@
</property>
<!-- END CAPTIONS -->
</propertyGroup>
<propertyGroup caption="Store value">
<property key="optionsSourceDatabaseValueAttribute" type="attribute" dataSource="optionsSourceDatabaseDataSource">
<caption>Value</caption>
<description />
<attributeTypes>
<attributeType name="String" />
<attributeType name="Integer" />
<attributeType name="Long" />
<attributeType name="Enum" />
</attributeTypes>
</property>
<property key="databaseAttributeString" type="attribute" setLabel="true" required="false">
<caption>Target attribute</caption>
<description />
<attributeTypes>
<attributeType name="String" />
<attributeType name="Integer" />
<attributeType name="Long" />
<attributeType name="Enum" />
</attributeTypes>
</property>
</propertyGroup>
<!-- END DATABASE / STRING -->
<propertyGroup caption="Attribute">
<!-- ASSOCIATION -->
<property key="attributeAssociation" type="association" selectableObjects="optionsSourceAssociationDataSource" required="true" setLabel="true">
<caption>Entity</caption>
<description />
<associationTypes>
<associationType name="Reference" />
<associationType name="ReferenceSet" />
</associationTypes>
</property>
<property key="optionsSourceAssociationDataSource" type="datasource" isList="true" required="false">
<caption>Selectable objects</caption>
<description />
</property>
</propertyGroup>
<!-- END OPTIONS SOURCE -->
<!-- STATIC-->
<propertyGroup caption="Values">
Expand Down Expand Up @@ -214,6 +214,11 @@
<enumerationValue key="radio">Radio button</enumerationValue>
</enumerationValues>
</property>
<property key="groupName" type="expression" required="false">
<caption>Group name</caption>
<description>Name for the group of associated inputs</description>
<returnType type="String" />
</property>
<!-- END MISC PROPS -->
</propertyGroup>
<!-- END GENERAL -->
Expand Down Expand Up @@ -271,10 +276,9 @@
<description />
<returnType type="Boolean" />
</property>
<property key="groupName" type="expression" required="false">
<caption>Group name</caption>
<property key="ariaLabel" type="string" defaultValue="" required="false">
<caption>Aria label</caption>
<description />
<returnType type="String" />
</property>
</propertyGroup>
</propertyGroup>
Expand Down
1 change: 1 addition & 0 deletions ...uggableWidgets/checkbox-radio-selection-web/src/__tests__/CheckboxRadioSelection.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ describe("CheckboxRadioSelection", () => {
customEditabilityExpression: { status: "available", value: false } as any,
readOnlyStyle: "bordered" as const,
ariaRequired: { status: "available", value: false } as any,
ariaLabel: "",
controlType: "checkbox" as const
};

Expand Down
22 changes: 12 additions & 10 deletions ...es/pluggableWidgets/checkbox-radio-selection-web/typings/CheckboxRadioSelectionProps.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,29 +45,30 @@ export interface CheckboxRadioSelectionContainerProps {
attributeBoolean: EditableValue<boolean>;
optionsSourceDatabaseDataSource?: ListValue;
optionsSourceDatabaseItemSelection?: SelectionSingleValue | SelectionMultiValue;
optionsSourceDatabaseValueAttribute?: ListAttributeValue<string | Big>;
databaseAttributeString?: EditableValue<string | Big>;
attributeAssociation: ReferenceValue | ReferenceSetValue;
optionsSourceAssociationDataSource?: ListValue;
optionsSourceAssociationCaptionType: OptionsSourceAssociationCaptionTypeEnum;
optionsSourceDatabaseCaptionType: OptionsSourceDatabaseCaptionTypeEnum;
optionsSourceAssociationCaptionAttribute?: ListAttributeValue<string>;
optionsSourceDatabaseCaptionAttribute?: ListAttributeValue<string>;
optionsSourceAssociationCaptionExpression?: ListExpressionValue<string>;
optionsSourceDatabaseCaptionExpression?: ListExpressionValue<string>;
optionsSourceDatabaseValueAttribute?: ListAttributeValue<string | Big>;
databaseAttributeString?: EditableValue<string | Big>;
attributeAssociation: ReferenceValue | ReferenceSetValue;
optionsSourceAssociationDataSource?: ListValue;
staticAttribute: EditableValue<string | Big | boolean | Date>;
optionsSourceStaticDataSource: OptionsSourceStaticDataSourceType[];
noOptionsText?: DynamicValue<string>;
optionsSourceCustomContentType: OptionsSourceCustomContentTypeEnum;
optionsSourceAssociationCustomContent?: ListWidgetValue;
optionsSourceDatabaseCustomContent?: ListWidgetValue;
controlType: ControlTypeEnum;
groupName?: DynamicValue<string>;
customEditability: CustomEditabilityEnum;
customEditabilityExpression: DynamicValue<boolean>;
readOnlyStyle: ReadOnlyStyleEnum;
onChangeEvent?: ActionValue;
ariaRequired: DynamicValue<boolean>;
groupName?: DynamicValue<string>;
ariaLabel: string;
}

export interface CheckboxRadioSelectionPreviewProps {
Expand All @@ -80,28 +81,29 @@ export interface CheckboxRadioSelectionPreviewProps {
attributeBoolean: string;
optionsSourceDatabaseDataSource: {} | { caption: string } | { type: string } | null;
optionsSourceDatabaseItemSelection: "Single" | "Multi" | "None";
optionsSourceDatabaseValueAttribute: string;
databaseAttributeString: string;
attributeAssociation: string;
optionsSourceAssociationDataSource: {} | { caption: string } | { type: string } | null;
optionsSourceAssociationCaptionType: OptionsSourceAssociationCaptionTypeEnum;
optionsSourceDatabaseCaptionType: OptionsSourceDatabaseCaptionTypeEnum;
optionsSourceAssociationCaptionAttribute: string;
optionsSourceDatabaseCaptionAttribute: string;
optionsSourceAssociationCaptionExpression: string;
optionsSourceDatabaseCaptionExpression: string;
optionsSourceDatabaseValueAttribute: string;
databaseAttributeString: string;
attributeAssociation: string;
optionsSourceAssociationDataSource: {} | { caption: string } | { type: string } | null;
staticAttribute: string;
optionsSourceStaticDataSource: OptionsSourceStaticDataSourcePreviewType[];
noOptionsText: string;
optionsSourceCustomContentType: OptionsSourceCustomContentTypeEnum;
optionsSourceAssociationCustomContent: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };
optionsSourceDatabaseCustomContent: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };
controlType: ControlTypeEnum;
groupName: string;
customEditability: CustomEditabilityEnum;
customEditabilityExpression: string;
readOnlyStyle: ReadOnlyStyleEnum;
onChangeEvent: {} | null;
onChangeDatabaseEvent: {} | null;
ariaRequired: string;
groupName: string;
ariaLabel: string;
}
Loading