Skip to content
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

remove direct polymorphic() calls #2195

Merged
merged 2 commits into from
Aug 20, 2024
Merged

remove direct polymorphic() calls #2195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0e0f5b
remove direct `polymorphic()` calls
mayank99 Aug 20, 2024
16e8422
words
mayank99 Aug 20, 2024
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
6 changes: 3 additions & 3 deletions packages/itwinui-react/src/core/List/ListItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,21 @@ export type ListItemOwnProps = {

// ----------------------------------------------------------------------------

const ListItemIcon = polymorphic('iui-list-item-icon');
const ListItemIcon = polymorphic.div('iui-list-item-icon');
if (process.env.NODE_ENV === 'development') {
ListItemIcon.displayName = 'ListItem.Icon';
}

// ----------------------------------------------------------------------------

const ListItemContent = polymorphic('iui-list-item-content');
const ListItemContent = polymorphic.div('iui-list-item-content');
if (process.env.NODE_ENV === 'development') {
ListItemContent.displayName = 'ListItem.Content';
}

// ----------------------------------------------------------------------------

const ListItemDescription = polymorphic('iui-list-item-description');
const ListItemDescription = polymorphic.div('iui-list-item-description');
if (process.env.NODE_ENV === 'development') {
ListItemDescription.displayName = 'ListItem.Description';
}
Expand Down
2 changes: 1 addition & 1 deletion packages/itwinui-react/src/core/Menu/MenuDivider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { polymorphic } from '../../utils/index.js';
* ]}
* </Menu>
*/
export const MenuDivider = polymorphic('iui-menu-divider', {
export const MenuDivider = polymorphic.div('iui-menu-divider', {
role: 'separator',
});
if (process.env.NODE_ENV === 'development') {
Expand Down
4 changes: 2 additions & 2 deletions packages/itwinui-react/src/core/Overlay/Overlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ if (process.env.NODE_ENV === 'development') {

// --------------------------------------------------------------------------------

const OverlayOverlay = polymorphic('iui-overlay');
const OverlayOverlay = polymorphic.div('iui-overlay');
if (process.env.NODE_ENV === 'development') {
OverlayOverlay.displayName = 'Overlay.Overlay';
}

// --------------------------------------------------------------------------------

const OverlayWrapper = polymorphic('iui-overlay-wrapper');
const OverlayWrapper = polymorphic.div('iui-overlay-wrapper');
if (process.env.NODE_ENV === 'development') {
OverlayWrapper.displayName = 'Overlay.Wrapper';
}
Expand Down
18 changes: 10 additions & 8 deletions packages/itwinui-react/src/core/Tile/Tile.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// Tile.ThumbnailArea component

const TileThumbnailArea = polymorphic('iui-tile-thumbnail');
const TileThumbnailArea = polymorphic.div('iui-tile-thumbnail');
if (process.env.NODE_ENV === 'development') {
TileThumbnailArea.displayName = 'Tile.ThumbnailArea';
}
Expand Down Expand Up @@ -234,15 +234,15 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// Tile.QuickAction component

const TileQuickAction = polymorphic('iui-tile-thumbnail-quick-action');
const TileQuickAction = polymorphic.div('iui-tile-thumbnail-quick-action');
if (process.env.NODE_ENV === 'development') {
TileQuickAction.displayName = 'Tile.QuickAction';
}

// ----------------------------------------------------------------------------
// Tile.TypeIndicator component

const TileTypeIndicator = polymorphic('iui-tile-thumbnail-type-indicator');
const TileTypeIndicator = polymorphic.div('iui-tile-thumbnail-type-indicator');
if (process.env.NODE_ENV === 'development') {
TileTypeIndicator.displayName = 'Tile.TypeIndicator';
}
Expand Down Expand Up @@ -274,7 +274,9 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// Tile.BadgeContainer component

const TileBadgeContainer = polymorphic('iui-tile-thumbnail-badge-container');
const TileBadgeContainer = polymorphic.div(
'iui-tile-thumbnail-badge-container',
);
if (process.env.NODE_ENV === 'development') {
TileBadgeContainer.displayName = 'Tile.BadgeContainer';
}
Expand Down Expand Up @@ -349,23 +351,23 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// Tile.ContentArea component

const TileContentArea = polymorphic('iui-tile-content');
const TileContentArea = polymorphic.div('iui-tile-content');
if (process.env.NODE_ENV === 'development') {
TileContentArea.displayName = 'Tile.ContentArea';
}

// ----------------------------------------------------------------------------
// Tile.Description component

const TileDescription = polymorphic('iui-tile-description');
const TileDescription = polymorphic.div('iui-tile-description');
if (process.env.NODE_ENV === 'development') {
TileDescription.displayName = 'Tile.Description';
}

// ----------------------------------------------------------------------------
// Tile.Metadata component

const TileMetadata = polymorphic('iui-tile-metadata');
const TileMetadata = polymorphic.div('iui-tile-metadata');
if (process.env.NODE_ENV === 'development') {
TileMetadata.displayName = 'Tile.Metadata';
}
Expand Down Expand Up @@ -425,7 +427,7 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// Tile.Buttons component

const TileButtons = polymorphic('iui-tile-buttons');
const TileButtons = polymorphic.div('iui-tile-buttons');
if (process.env.NODE_ENV === 'development') {
TileButtons.displayName = 'Tile.Buttons';
}
Expand Down
4 changes: 2 additions & 2 deletions packages/itwinui-react/src/core/TransferList/TransferList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { Label } from '../Label/Label.js';
// ----------------------------------------------------------------------------
// TransferListComponent

const TransferListComponent = polymorphic('iui-transfer-list-wrapper');
const TransferListComponent = polymorphic.div('iui-transfer-list-wrapper');
if (process.env.NODE_ENV === 'development') {
TransferListComponent.displayName = 'TransferList';
}
Expand Down Expand Up @@ -226,7 +226,7 @@ if (process.env.NODE_ENV === 'development') {
// ----------------------------------------------------------------------------
// TransferList.Toolbar component

const TransferListToolbar = polymorphic('iui-transfer-list-toolbar', {
const TransferListToolbar = polymorphic.div('iui-transfer-list-toolbar', {
role: 'toolbar',
});
if (process.env.NODE_ENV === 'development') {
Expand Down
18 changes: 0 additions & 18 deletions packages/itwinui-react/src/utils/functions/polymorphic.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,6 @@
import { render } from '@testing-library/react';
import { polymorphic } from './polymorphic.js';

it('should work when called directly', () => {
const MyDiv = polymorphic('my-div');

const { container: container1 } = render(<MyDiv data-testid='foo'>🍏</MyDiv>);
const el1 = container1.querySelector('div.my-div') as HTMLElement;
expect(el1).toHaveTextContent('🍏');
expect(el1).toHaveAttribute('data-testid', 'foo');

const { container: container2 } = render(
<MyDiv as='span' data-testid='bar'>
🥭
</MyDiv>,
);
const el2 = container2.querySelector('span.my-div') as HTMLElement;
expect(el2).toHaveTextContent('🥭');
expect(el2).toHaveAttribute('data-testid', 'bar');
});

it('should work when called as property', () => {
const MyButton = polymorphic.button('my-button');

Expand Down
12 changes: 4 additions & 8 deletions packages/itwinui-react/src/utils/functions/polymorphic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,21 @@ const _base = <As extends keyof JSX.IntrinsicElements = 'div'>(
/**
* Utility to create a type-safe polymorphic component with a simple class.
*
* Can be called directly or as a property of the `polymorphic` object.
* In both cases, returns a component that:
* Should be called as a property of the `polymorphic` object.
* Returns a component that:
* - uses CSS-modules scoped classes
* - supports `as` prop with default element
* - forwards ref and spreads rest props
* - adds and merges CSS classes
* - adds tabIndex to interactive elements (Safari workaround)
*
* @example
* const MyPolyDiv = polymorphic('my-poly-div');
* <MyPolyDiv>...</MyPolyDiv>;
*
* @example
* const MyPolyButton = polymorphic.button('my-poly-button', { type: 'button' });
* <MyPolyButton as='a' href='#'>...</MyPolyButton>;
*
* @private
*/
export const polymorphic = new Proxy(_base('div'), {
export const polymorphic = new Proxy({} as never, {
get: (target, prop) => {
if (typeof prop === 'string') {
// eslint-disable-next-line -- string is as far as we can narrow it down
Expand All @@ -76,7 +72,7 @@ export const polymorphic = new Proxy(_base('div'), {
}
return Reflect.get(target, prop);
},
}) as ReturnType<typeof _base> & {
}) as {
[key in keyof JSX.IntrinsicElements]: ReturnType<typeof _base<key>>;
};

Expand Down
Loading