Skip to content
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
1 change: 1 addition & 0 deletions UNRELEASED.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f

- Migrated `ContextualSaveBar` to use hooks instead of `withAppProvider` ([#2091](https://github.com/Shopify/polaris-react/pull/2091))
- Migrated `RangeSlider`, `ScrollLock` and `TopBar.SearchField` to use hooks instead of withAppProvider ([#2083](https://github.com/Shopify/polaris-react/pull/2083))
- Updated `ResourceItem` to no longer rely on withAppProvider ([#2094](https://github.com/Shopify/polaris-react/pull/2094))

### Deprecations
52 changes: 21 additions & 31 deletions src/components/ResourceItem/ResourceItem.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import React from 'react';
import React, {useContext} from 'react';
import {HorizontalDotsMinor} from '@shopify/polaris-icons';
import {createUniqueIDFactory} from '@shopify/javascript-utilities/other';
import isEqual from 'lodash/isEqual';
import {classNames} from '../../utilities/css';
import {useI18n} from '../../utilities/i18n';
import {DisableableAction} from '../../types';
import {ActionList} from '../ActionList';
import {Popover} from '../Popover';
Expand All @@ -12,10 +13,6 @@ import {ThumbnailProps} from '../Thumbnail';
import {ButtonGroup} from '../ButtonGroup';
import {Checkbox} from '../Checkbox';
import {Button, buttonsFrom} from '../Button';
import {
withAppProvider,
WithAppProviderProps,
} from '../../utilities/with-app-provider';

import {
ResourceListContext,
Expand All @@ -30,11 +27,7 @@ export type MediaSize = 'small' | 'medium' | 'large';

export type MediaType = 'avatar' | 'thumbnail';

interface WithContextTypes<IJ> {
context: IJ;
}

export interface Props {
export interface BaseProps {
/** Visually hidden text for screen readers used for item link*/
accessibilityLabel?: string;
/** Individual item name used by various text labels */
Expand All @@ -61,32 +54,31 @@ export interface Props {
children?: React.ReactNode;
}

export interface PropsWithUrl extends Props {
export interface PropsWithUrl extends BaseProps {
url: string;
onClick?(id?: string): void;
}

export interface PropsWithClick extends Props {
export interface PropsWithClick extends BaseProps {
url?: string;
onClick(id?: string): void;
}

export type ResourceItemProps = PropsWithUrl | PropsWithClick;

interface PropsFromWrapper {
context: React.ContextType<typeof ResourceListContext>;
i18n: ReturnType<typeof useI18n>;
}

interface State {
actionsMenuVisible: boolean;
focused: boolean;
focusedInner: boolean;
selected: boolean;
}

export type CombinedProps =
| PropsWithUrl &
WithAppProviderProps &
WithContextTypes<React.ContextType<typeof ResourceListContext>>
| PropsWithClick &
WithAppProviderProps &
WithContextTypes<React.ContextType<typeof ResourceListContext>>;
export type CombinedProps = PropsFromWrapper & (PropsWithUrl | PropsWithClick);

const getUniqueCheckboxID = createUniqueIDFactory('ResourceListItemCheckbox');
const getUniqueOverlayID = createUniqueIDFactory('ResourceListItemOverlay');
Expand Down Expand Up @@ -143,10 +135,10 @@ class BaseResourceItem extends React.Component<CombinedProps, State> {
ariaControls,
ariaExpanded,
persistActions = false,
polaris: {intl},
accessibilityLabel,
name,
context: {selectable, selectMode, loading},
i18n,
} = this.props;

const {actionsMenuVisible, focused, focusedInner, selected} = this.state;
Expand All @@ -162,7 +154,7 @@ class BaseResourceItem extends React.Component<CombinedProps, State> {

if (selectable) {
const checkboxAccessibilityLabel =
name || accessibilityLabel || intl.translate('Polaris.Common.checkbox');
name || accessibilityLabel || i18n.translate('Polaris.Common.checkbox');

handleMarkup = (
<div
Expand Down Expand Up @@ -221,10 +213,10 @@ class BaseResourceItem extends React.Component<CombinedProps, State> {
);

const disclosureAccessibilityLabel = name
? intl.translate('Polaris.ResourceList.Item.actionsDropdownLabel', {
? i18n.translate('Polaris.ResourceList.Item.actionsDropdownLabel', {
accessibilityLabel: name,
})
: intl.translate('Polaris.ResourceList.Item.actionsDropdown');
: i18n.translate('Polaris.ResourceList.Item.actionsDropdown');

disclosureMarkup = (
<div className={styles.Disclosure} onClick={stopPropagation}>
Expand Down Expand Up @@ -434,14 +426,12 @@ function isSelected(id: string, selectedItems?: ResourceListSelectedItems) {
);
}

function ResourceItem(props: CombinedProps) {
export function ResourceItem(props: ResourceItemProps) {
return (
<ResourceListContext.Consumer>
{(context) => <BaseResourceItem {...props} context={context} />}
</ResourceListContext.Consumer>
<BaseResourceItem
{...props}
context={useContext(ResourceListContext)}
i18n={useI18n()}
/>
);
}

// Use named export once withAppProvider is refactored away
// eslint-disable-next-line import/no-default-export
export default withAppProvider<Props>()(ResourceItem);
4 changes: 1 addition & 3 deletions src/components/ResourceItem/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
import ResourceItem, {ResourceItemProps} from './ResourceItem';

export {ResourceItem, ResourceItemProps};
export {ResourceItem, ResourceItemProps} from './ResourceItem';
2 changes: 1 addition & 1 deletion src/components/ResourceItem/tests/ResourceItem.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
Button,
} from 'components';
import {ResourceListContext} from '../../../utilities/resource-list';
import ResourceItem from '../ResourceItem';
import {ResourceItem} from '../ResourceItem';

describe('<ResourceItem />', () => {
let spy: jest.SpyInstance;
Expand Down