diff --git a/packages/eui/changelogs/upcoming/8812.md b/packages/eui/changelogs/upcoming/8812.md new file mode 100644 index 00000000000..387c0b76917 --- /dev/null +++ b/packages/eui/changelogs/upcoming/8812.md @@ -0,0 +1,6 @@ +- Added `noItemsMessage` prop to `EuiInMemoryTable` + +**Deprecations** + +- Deprecated `message` prop in `EuiInMemoryTable` in favor of `noItemsMessage` which is a more meaningful prop name; there are no functional changes + diff --git a/packages/eui/src/components/basic_table/in_memory_table.stories.tsx b/packages/eui/src/components/basic_table/in_memory_table.stories.tsx index b4794b9bb5d..2292ee5892a 100644 --- a/packages/eui/src/components/basic_table/in_memory_table.stories.tsx +++ b/packages/eui/src/components/basic_table/in_memory_table.stories.tsx @@ -30,7 +30,7 @@ const meta: Meta = { error: '', loading: false, // Set to strings for easier testing - message: '', + noItemsMessage: '', childrenBetween: '', // Inherited from EuiTable responsiveBreakpoint: 'm', diff --git a/packages/eui/src/components/basic_table/in_memory_table.test.tsx b/packages/eui/src/components/basic_table/in_memory_table.test.tsx index 9ee07e98cbd..b1af9fb8108 100644 --- a/packages/eui/src/components/basic_table/in_memory_table.test.tsx +++ b/packages/eui/src/components/basic_table/in_memory_table.test.tsx @@ -53,7 +53,7 @@ describe('EuiInMemoryTable', () => { expect(container.firstChild).toMatchSnapshot(); }); - test('with message', () => { + test('with noItemsMessage', () => { const props: EuiInMemoryTableProps = { ...requiredProps, items: [], @@ -64,14 +64,14 @@ describe('EuiInMemoryTable', () => { description: 'description', }, ], - message: 'where my items at?', + noItemsMessage: 'where my items at?', }; const { getByText } = render(); expect(getByText('where my items at?')).toBeTruthy(); }); - test('with message and loading', () => { + test('with noItemsMessage and loading', () => { const props: EuiInMemoryTableProps = { ...requiredProps, items: [], @@ -82,7 +82,7 @@ describe('EuiInMemoryTable', () => { description: 'description', }, ], - message: 'Loading items....', + noItemsMessage: 'Loading items....', loading: true, }; const { container } = render(); @@ -136,10 +136,10 @@ describe('EuiInMemoryTable', () => { expect(getByText('expanded row content')).toBeTruthy(); }); - test('with items and message - expecting to show the items', () => { + test('with items and noItemsMessage - expecting to show the items', () => { const props: EuiInMemoryTableProps = { ...requiredProps, - message: 'show me!', + noItemsMessage: 'show me!', items: [ { id: '1', name: 'name1' }, { id: '2', name: 'name2' }, @@ -1036,7 +1036,7 @@ describe('EuiInMemoryTable', () => { defaultQuery: 'No', }, className: 'testTable', - message: No items found!, + noItemsMessage: No items found!, }; const { container } = render(); @@ -1080,7 +1080,7 @@ describe('EuiInMemoryTable', () => { defaultQuery: 'No', }, className: 'testTable', - message: No items found!, + noItemsMessage: No items found!, }; const { container: container2 } = render( diff --git a/packages/eui/src/components/basic_table/in_memory_table.tsx b/packages/eui/src/components/basic_table/in_memory_table.tsx index 70a42f511a6..26508487fbd 100644 --- a/packages/eui/src/components/basic_table/in_memory_table.tsx +++ b/packages/eui/src/components/basic_table/in_memory_table.tsx @@ -75,7 +75,15 @@ type InMemoryTableProps = Omit< EuiBasicTableProps, 'pagination' | 'sorting' | 'noItemsMessage' | 'onChange' > & { + /** + * Message to display if table is empty + * @deprecated Use `noItemsMessage` instead. + */ message?: ReactNode; + /** + * Message to display if table is empty + */ + noItemsMessage?: ReactNode; /** * Configures {@link Search}. */ @@ -677,6 +685,7 @@ export class EuiInMemoryTable extends Component< columns, loading, message, + noItemsMessage, error, selection, compressed, @@ -750,7 +759,7 @@ export class EuiInMemoryTable extends Component< onChange={this.onTableChange} error={error} loading={loading} - noItemsMessage={message} + noItemsMessage={noItemsMessage || message} tableLayout={tableLayout} compressed={compressed} itemIdToExpandedRowMap={itemIdToExpandedRowMap} diff --git a/packages/website/docs/components/tables/table_selection.tsx b/packages/website/docs/components/tables/table_selection.tsx index 1b1d65beda5..72ec95c5305 100644 --- a/packages/website/docs/components/tables/table_selection.tsx +++ b/packages/website/docs/components/tables/table_selection.tsx @@ -365,7 +365,7 @@ export default () => { rowHeader="firstName" error={error} loading={loading} - message={message} + noItemsMessage={message} search={search} sorting={true} pagination={pagination}