Skip to content

refactor: harmonize prop/enum names #6040

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.

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

Merged
merged 15 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 20 additions & 8 deletions docs/MigrationGuide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,8 @@ Please use the following components instead:

**Renamed Props:**

- `a11yConfig.dynamicPageAnchorBar` has been renamed to `a11yConfig.objectPageAnchorBar`
- `a11yConfig` has been renamed to `accessibilityAttributes`
- `a11yConfig.dynamicPageAnchorBar` has been renamed to `accessibilityAttributes.objectPageAnchorBar`

Also, the namings of internal `data-component-name` attributes have been adjusted accordingly. E.g. `data-component-name="DynamicPageTitleSubHeader"` has been renamed to `data-component-name="ObjectPageTitleSubHeader"`

Expand Down Expand Up @@ -443,16 +444,15 @@ function MyComponent() {
### ActionSheet

The prop `portalContainer` has been removed as it is no longer needed due to the [popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API) which is now used in the UI5 Web Components.
For a better aligned API, the `showCancelButton` prop has been replaced wih the `hideCancelButton` prop and the logic has been inverted.
You only need to apply changes to your code if `showCancelButton` has been set to `false`.
For a better aligned API, the `showCancelButton` prop has been replaced wih the `hideCancelButton` prop and the logic has been inverted. Also, the `a11yConfig` prop has been renamed to `accessibilityAttributes`.

```tsx
// v1
import { ActionSheet, Button } from '@ui5/webcomponents-react';

function MyComponent() {
return (
<ActionSheet showCancelButton={false}>
<ActionSheet showCancelButton={false} a11yConfig={{ actionSheetMobileContent: { role: 'menu' } }}>
<Button>Action 1</Button>
</ActionSheet>
);
Expand All @@ -463,7 +463,7 @@ import { ActionSheet, Button } from '@ui5/webcomponents-react';

function MyComponent() {
return (
<ActionSheet hideCancelButton>
<ActionSheet hideCancelButton accessibilityAttributes={{ actionSheetMobileContent: { role: 'menu' } }}>
<Button>Action 1</Button>
</ActionSheet>
);
Expand All @@ -483,13 +483,19 @@ function MyComponent() {

**Renamed Enums:**

Only the names of the following enums have changed, so it's sufficient to replace them with the new name.
Names of the following enums have changed:

- `TableScaleWidthMode` is now `AnalyticalTableScaleWidthMode`
- `TableSelectionBehavior` is now `AnalyticalTableSelectionBehavior`
- `TableSelectionMode` is now `AnalyticalTableSelectionMode`
- `TableVisibleRowCountMode` is now `AnalyticalTableVisibleRowCountMode`

**Changed Enums:**

- The properties and values for the `AnalyticalTableSelectionMode` enum has been changed.
- `SingleSelect` is now `Single`
- `MultiSelect` is now `Multiple`.

**[Column Properties](https://sap.github.io/ui5-webcomponents-react/?path=/docs/data-display-analyticaltable--docs#column-properties) Changes**

- `canReorder` has been removed, please use `disableDragAndDrop` instead.
Expand All @@ -505,6 +511,7 @@ const columns = [{ ...otherProperties, canReorder: false }];
scaleWidthMode={TableScaleWidthMode.Grow}
selectionBehavior={TableSelectionBehavior.Row}
selectionMode={TableSelectionMode.MultiSelect}
// selectionMode={TableSelectionMode.SingleSelect}
visibleRowCountMode={TableVisibleRowCountMode.Interactive}
/>;

Expand All @@ -517,7 +524,8 @@ const columns = [{ ...otherProps, disableDragAndDrop: true }];
subComponentsBehavior={AnalyticalTableSubComponentsBehavior.Visible}
scaleWidthMode={AnalyticalTableScaleWidthMode.Grow}
selectionBehavior={AnalyticalTableSelectionBehavior.Row}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
// selectionMode={AnalyticalTableSelectionMode.Single}
visibleRowCountMode={AnalyticalTableVisibleRowCountMode.Interactive}
/>;
```
Expand Down Expand Up @@ -610,9 +618,13 @@ The prop `titleText` is now required and the default value `true` has been remov

The prop `titleText` is now required.

### ObjectStatus

For better alignment with the UI5 Web Components the `active` prop has been renamed to `interactive`.

## Enum Changes

For a better alignment with the UI5 Web Components, the following enums have been renamed:
For better alignment with the UI5 Web Components, the following enums have been renamed:

- `MessageBoxActions` has been renamed to `MessageBoxAction`
- `MessageBoxTypes` has been renamed to `MessageBoxType`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@
},
"ActionSheet": {
"changedProps": {
"a11yConfig": "accessibilityAttributes",
"onAfterClose": "onClose",
"onAfterOpen": "onOpen",
"placementType": "placement",
"showCancelButton": "hideCancelButton"
},
"removedProps": ["portalContainer"]
},
"AnalyticalTable": {},
"AnalyticalTable": {
"renamedEnums": {
"selectionMode": "AnalyticalTableSelectionMode"
}
},
"Avatar": {},
"Badge": {
"newComponent": "Tag"
Expand Down Expand Up @@ -286,7 +291,15 @@
},
"removedProps": ["selected"]
},
"ObjectPage": {
"changedProps": {
"a11yConfig": "accessibilityAttributes"
}
},
"ObjectStatus": {
"changedProps": {
"active": "interactive"
},
"renamedEnums": {
"state": "ValueState"
}
Expand Down Expand Up @@ -618,6 +631,10 @@
"Themes": "Theme"
},
"enumProperties": {
"AnalyticalTableSelectionMode": {
"SingleSelect": "Single",
"MultiSelect": "Multiple"
},
"BusyIndicatorSize": {
"Small": "S",
"Medium": "M",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const meta = {
header: {
control: { disable: true }
},
a11yConfig: { table: { category: 'A11y props' } }
accessibilityAttributes: { table: { category: 'Accessibility props' } }
},
args: {
horizontalAlign: PopoverHorizontalAlign.Center,
Expand Down
9 changes: 5 additions & 4 deletions packages/main/src/components/ActionSheet/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ export interface ActionSheetPropTypes extends Omit<ResponsivePopoverPropTypes, '
*/
hideCancelButton?: boolean;
/**
* Defines internally used a11y properties.
* Defines internally used accessibility properties/attributes.
*/
a11yConfig?: {
accessibilityAttributes?: {
actionSheetMobileContent?: {
role?: string;
};
Expand Down Expand Up @@ -116,7 +116,8 @@ function ActionSheetButton(props: ActionSheetButtonPropTypes) {
*
*/
const ActionSheet = forwardRef<ResponsivePopoverDomRef, ActionSheetPropTypes>((props, ref) => {
const { a11yConfig, children, className, header, headerText, hideCancelButton, onOpen, open, ...rest } = props;
const { accessibilityAttributes, children, className, header, headerText, hideCancelButton, onOpen, open, ...rest } =
props;

useStylesheet(styleData, ActionSheet.displayName);

Expand Down Expand Up @@ -229,7 +230,7 @@ const ActionSheet = forwardRef<ResponsivePopoverDomRef, ActionSheetPropTypes>((p
<div
className={isPhone() ? classNames.contentMobile : undefined}
data-component-name="ActionSheetMobileContent"
role={a11yConfig?.actionSheetMobileContent?.role ?? 'application'}
role={accessibilityAttributes?.actionSheetMobileContent?.role ?? 'application'}
onKeyDown={handleKeyDown}
ref={actionBtnsRef}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ describe('AnalyticalTable', () => {
}}
data={dataTree}
globalFilterValue={filter}
selectionMode="MultiSelect"
selectionMode="Multiple"
/>
<div data-testid="payloadHelper">
{JSON.stringify(relevantPayload?.selectedFlatRows?.filter(Boolean).length)}
Expand Down Expand Up @@ -587,7 +587,7 @@ describe('AnalyticalTable', () => {
setAllRowsSelected(e.detail.allRowsSelected);
onRowSelect(e);
}}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
selectedRowIds={selectedRowIds}
/>
<p>
Expand Down Expand Up @@ -790,7 +790,7 @@ describe('AnalyticalTable', () => {
onRowSelect(e);
}}
data={groupableData}
selectionMode="MultiSelect"
selectionMode="Multiple"
/>
<div data-testid="selectedFlatRowsLength">
{JSON.stringify(relevantPayload?.selectedFlatRows?.filter(Boolean).length)}
Expand Down Expand Up @@ -833,7 +833,7 @@ describe('AnalyticalTable', () => {
return (
<>
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
data={dataTree}
columns={columns}
isTreeTable
Expand Down Expand Up @@ -947,7 +947,7 @@ describe('AnalyticalTable', () => {
const indeterminateChange = cy.spy().as('onIndeterminateChangeSpy');
cy.mount(
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
data={dataTree}
columns={columns}
isTreeTable
Expand Down Expand Up @@ -1086,7 +1086,7 @@ describe('AnalyticalTable', () => {
[
{ props: {}, bothWidth: 952, onlyNameWidth: 1904, onlyAgeWidth: 1904 },
{
props: { selectionMode: AnalyticalTableSelectionMode.MultiSelect },
props: { selectionMode: AnalyticalTableSelectionMode.Multiple },
bothWidth: 930,
onlyNameWidth: 1860,
onlyAgeWidth: 1860
Expand All @@ -1107,7 +1107,7 @@ describe('AnalyticalTable', () => {
props: {
withNavigationHighlight: true,
withRowHighlight: true,
selectionMode: AnalyticalTableSelectionMode.SingleSelect
selectionMode: AnalyticalTableSelectionMode.Single
},
bothWidth: 924,
onlyNameWidth: 1848,
Expand Down Expand Up @@ -1397,9 +1397,7 @@ describe('AnalyticalTable', () => {
accessor: 'friend.name'
}
];
cy.mount(
<AnalyticalTable selectionMode="SingleSelect" data={data.slice(0, 2)} columns={columns} onRowSelect={select} />
);
cy.mount(<AnalyticalTable selectionMode="Single" data={data.slice(0, 2)} columns={columns} onRowSelect={select} />);
cy.findAllByText('Custom Cell Button')
.should('have.length', 2)
.each(($cellBtn) => {
Expand Down Expand Up @@ -1429,7 +1427,7 @@ describe('AnalyticalTable', () => {
}
];
cy.mount(
<AnalyticalTable selectionMode="SingleSelect" data={data.slice(0, 2)} columns={columns2} onRowSelect={select} />
<AnalyticalTable selectionMode="Single" data={data.slice(0, 2)} columns={columns2} onRowSelect={select} />
);
cy.findAllByText('Custom Cell Button')
.should('have.length', 2)
Expand Down Expand Up @@ -1536,7 +1534,7 @@ describe('AnalyticalTable', () => {
<AnalyticalTable
data={data}
columns={columns}
selectionMode={AnalyticalTableSelectionMode.SingleSelect}
selectionMode={AnalyticalTableSelectionMode.Single}
selectionBehavior={AnalyticalTableSelectionBehavior.RowOnly}
/>
);
Expand All @@ -1545,7 +1543,7 @@ describe('AnalyticalTable', () => {
<AnalyticalTable
data={data}
columns={columns}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
selectionBehavior={AnalyticalTableSelectionBehavior.RowOnly}
/>
);
Expand All @@ -1572,7 +1570,7 @@ describe('AnalyticalTable', () => {
data={data}
columns={columns}
withNavigationHighlight
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
markNavigatedRow={markNavigatedRow}
onRowSelect={onRowSelect}
/>
Expand All @@ -1595,7 +1593,7 @@ describe('AnalyticalTable', () => {
const selectedRowColor = cssVarToRgb(ThemingParameters.sapList_SelectionBackgroundColor);
cy.mount(
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.SingleSelect}
selectionMode={AnalyticalTableSelectionMode.Single}
data={data}
columns={columns}
reactTableOptions={{
Expand All @@ -1620,7 +1618,7 @@ describe('AnalyticalTable', () => {
data={data}
columns={columns}
selectionBehavior={AnalyticalTableSelectionBehavior.Row}
selectionMode={AnalyticalTableSelectionMode.SingleSelect}
selectionMode={AnalyticalTableSelectionMode.Single}
onRowClick={rowClick}
onRowSelect={rowSelect}
/>
Expand Down Expand Up @@ -1648,7 +1646,7 @@ describe('AnalyticalTable', () => {
data={data}
columns={columns}
selectionBehavior={AnalyticalTableSelectionBehavior.Row}
selectionMode={AnalyticalTableSelectionMode.SingleSelect}
selectionMode={AnalyticalTableSelectionMode.Single}
onRowClick={rowSelectWithoutSelCell}
onRowSelect={rowSelect}
/>
Expand Down Expand Up @@ -2005,7 +2003,7 @@ describe('AnalyticalTable', () => {
columns={columns}
onRowSelect={onRowSelect}
onRowClick={onRowClick}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
tableHooks={[useRowDisableSelection('disableSelection')]}
minRows={1}
/>
Expand Down Expand Up @@ -2041,7 +2039,7 @@ describe('AnalyticalTable', () => {
it('plugin hook: useManualRowSelect', () => {
cy.mount(
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
data={manualSelectData}
columns={columns}
tableHooks={[useManualRowSelect('isSelected')]}
Expand All @@ -2059,7 +2057,7 @@ describe('AnalyticalTable', () => {
const [, ...updatedManualSelectData] = manualSelectData;
cy.mount(
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
data={[
{
name: 'Selected',
Expand Down Expand Up @@ -2096,7 +2094,7 @@ describe('AnalyticalTable', () => {
Show Selected
</Button>
<AnalyticalTable
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
data={data}
columns={columns}
tableInstance={instance}
Expand Down Expand Up @@ -2388,7 +2386,7 @@ describe('AnalyticalTable', () => {
<AnalyticalTable
columns={columns}
data={data}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
onRowSelect={handleSelect}
/>
<span data-testid="payload">{stringifiedPl}</span>
Expand Down Expand Up @@ -2825,7 +2823,7 @@ describe('AnalyticalTable', () => {
<AnalyticalTable
data={generateMoreData(50)}
columns={columns}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
/>
);

Expand All @@ -2838,7 +2836,7 @@ describe('AnalyticalTable', () => {
<AnalyticalTable
data={generateMoreData(50)}
columns={columns}
selectionMode={AnalyticalTableSelectionMode.MultiSelect}
selectionMode={AnalyticalTableSelectionMode.Multiple}
withRowHighlight
/>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ import * as ComponentStories from './AnalyticalTable.stories';
selectedRowIds={{
3: true
}}
selectionMode="SingleSelect"
selectionMode="Single"
withRowHighlight
/>
```
Expand Down
Loading
Loading