@workday/canvas-kit-docs 6.2.3 → 6.3.1

package/dist/commonjs/lib/specs.js

@@ -6013,7 +6013,7 @@ module.exports = {specifications: [
               },
               {
                 "type": "describe",
-                "name": "when the \"Delete\" button is hovered",
+                "name": "when the \"Some Text\" text is hovered",
                 "children": [
                   {
                     "type": "it",

package/dist/es6/lib/specs.js

@@ -6013,7 +6013,7 @@ module.exports = {specifications: [
               },
               {
                 "type": "describe",
-                "name": "when the \"Delete\" button is hovered",
+                "name": "when the \"Some Text\" text is hovered",
                 "children": [
                   {
                     "type": "it",

package/dist/mdx/TESTING.mdx

@@ -29,7 +29,7 @@ do. A "test" simply has to pass. A specification requires meaning.
 test('SomeComponent should render correctly', async () => {
   const {getByTestId} = render(<SomeComponent data-testid="test" text="foo" />);
 
-  const component = await getByTestId('test');
+  const component = getByTestId('test');
 
   expect(component.textContent).toEqual('foo');
   expect(component.getAttribute('aria-label')).toEqual('foo');
@@ -53,14 +53,14 @@ describe('SomeComponent', () => {
   it('should render the "text" prop as the text', async () => {
     const {getByTestId} = render(<SomeComponent data-testid="test" text="foo" />);
 
-    const component = await getByTestId('test');
+    const component = getByTestId('test');
     expect(component).toHaveTextContent('foo');
   });
 
   it('should render the "text" prop as an aria-label for accessibility', async () => {
     const {getByTestId} = render(<SomeComponent data-testid="test" text="foo" />);
 
-    const component = await getByTestId('test');
+    const component = getByTestId('test');
     expect(component).toHaveAttribute('aria-label', 'foo');
   });
 });
@@ -124,8 +124,8 @@ const {getByTestId} = render(
   </SomeComponent>
 );
 
-const component = await getByTestId('container');
-const child = await getByTestId('test');
+const component = getByTestId('container');
+const child = getByTestId('test');
 
 expect(component).toContainElement(child);
 ```
@@ -136,6 +136,30 @@ specification is met). Also this example will have a more useful failure message
 `.toContainElement` has the context that it is expecting an element in another element vs a match of
 a string.
 
+### Snapshot tests
+
+Canvas Kit does not contain DOM-based snapshot tests and uses [Visual Tests](#visual-tests) instead.
+DOM snapshots failures are often difficult to parse. Humans tend to be better at noticing and
+discerning visual changes than changes to a DOM structure.
+
+If your project uses snapshot tests and Canvas Kit, chances are you'll run into issues with changing
+ids and other ARIA attributes. Canvas Kit generates unique ids that are different every time the
+page loads. This can be a problem with snapshot tests. To fix this, you'll need to add special code
+to your test bootstrap file. For example:
+
+```ts
+import {setUniqueSeed, resetUniqueIdCount} from '@workday/canvas-kit-react/common';
+
+beforeEach(() => {
+  setUniqueSeed('a'); // set a static seed
+  resetUniqueIdCount(); // reset the id counter before every test
+});
+```
+
+This will ensure snapshot tests have stable ids for each snapshot. It is still possible to get ids
+changing if you add an additional component that uses id generation - subsequent ids will be
+different, but this will prevent snapshot tests that don't have any changes from showing diffs.
+
 ## Functional tests
 
 Canvas Kit uses [Cypress][https://cypress.io] for browser-based behavior testing (additional info:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "6.2.3",
+  "version": "6.3.1",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-react": "^6.2.3"
+    "@workday/canvas-kit-react": "^6.3.1"
   },
   "devDependencies": {
     "fs-extra": "^10.0.0",
@@ -58,5 +58,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "^3.8.3"
   },
-  "gitHead": "64f8a882e13dacffa99b98da64243f0bfabb5365"
+  "gitHead": "687b8d43c6e258200c4b939d4efb922df96d92ea"
 }