Merge pull request #823 from securityscorecard/table-docs-update

docs: update Datatable persisted state docs
securityscorecard · Oct 3, 2023 · 1e717bb · 1e717bb
2 parents cd269b7 + 8b471fa
commit 1e717bb
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/...cted/components_Datatable_internalComponents_Datatable_With Persisted State.png b/...cted/components_Datatable_internalComponents_Datatable_With Persisted State.png
diff --git a/src/components/Datatable/DatatableTests.stories.tsx b/src/components/Datatable/DatatableTests.stories.tsx
@@ -14,6 +14,8 @@ import { simpleColumns } from '../_internal/BaseTable/mocks/columns';
 import { DatatableProps } from './Datatable.types';
 import { DatatableStore, datatableInitialState } from './Datatable.store';
 import { tableActionsMock } from './mocks/actions';
+import { Text } from '../typographyLegacy';
+import { Stack } from '../layout';
 
 MockDate.set('2021-03-31T00:00:00Z');
 
@@ -302,3 +304,17 @@ WithPersistedState.args = {
   ...MinimalConfig.args,
   id: 'persisted_state',
 };
+WithPersistedState.parameters = {
+  screenshot: { skip: true },
+};
+WithPersistedState.decorators = [
+  (storyFn) => (
+    <Stack gap="md">
+      <Text>
+        An id must be provided to the Datatable in order to persists the table
+        configuration.
+      </Text>
+      {storyFn()}
+    </Stack>
+  ),
+];