Error summary unit tests and docs

tgreyuk · Jun 29, 2020 · 881d20f · 881d20f
1 parent df8cd22
commit 881d20f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/components/govukwc-error-summary/README.md b/components/govukwc-error-summary/README.md
@@ -17,7 +17,7 @@ import 'govukwc-webcomponents/components/govukwc-error-summary/govukwc-error-sum
 
 | Property  |  Type     | Default | Description |
 |-----------|-----------|---------|-------------|
-| `title`|`string`|""|""| 
+| `title`|`string`|""|Error summary title| 
 
 ### Slots
 
@@ -31,6 +31,6 @@ import 'govukwc-webcomponents/components/govukwc-error-summary/govukwc-error-sum
 
 | Property  |  Type     | Default | Description |
 |-----------|-----------|---------|-------------|
-| `target`|`string`|""|""
-| `message`|`string`|""|""| 
+| `target`|`string`|""|The target id of invalid component
+| `message`|`string`|""|Associated error message| 
 
diff --git a/components/govukwc-error-summary/govukwc-error-summary-item.js b/components/govukwc-error-summary/govukwc-error-summary-item.js
@@ -3,7 +3,13 @@ import { html, LitElement } from 'lit-element';
 export class ErrorSummaryItemComponent extends LitElement {
   static get properties() {
     return {
+      /**
+       * The target id of invalid component
+       */
       target: { type: String },
+      /**
+       * Associated error message
+       */
       message: { type: String },
     };
   }

diff --git a/components/govukwc-error-summary/govukwc-error-summary.js b/components/govukwc-error-summary/govukwc-error-summary.js
@@ -11,6 +11,9 @@ import './govukwc-error-summary-item';
 export class ErrorSummaryComponent extends LitElement {
   static get properties() {
     return {
+      /**
+       * Error summary title
+       */
       title: { type: String },
     };
   }

diff --git a/components/govukwc-error-summary/govukwc-error-summary.test.js b/components/govukwc-error-summary/govukwc-error-summary.test.js
@@ -0,0 +1,9 @@
+import { fixture, expect } from '@open-wc/testing';
+import * as stories from './govukwc-error-summary.stories';
+
+describe('govukwc-error-summary', () => {
+  it(`should render`, async () => {
+    const el = await fixture(stories.Default());
+    expect(el.shadowRoot.innerHTML).to.equalSnapshot();
+  });
+});