@qld-gov-au/qgds-bootstrap5 2.0.11 → 2.0.12

package/src/components/bs5/select/Select.stories.js

@@ -1,131 +1,75 @@
 // ComponentExample.stories.js
-import { Select } from "./Select.js";
+import { Select, argTypes } from "./Select.js";
 import defaultdata from "./select.data.json";
 
 export default {
   tags: ["autodocs"],
   title: "3. Components/Forms/Select",
   render: (args) => {
-    
-    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc. 
+    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc.
     //We can't use commas on our class="..." attribute, so we need to replace the commas with spaces.
 
-    if( typeof(args.customClass) === 'string' ) {
-      args.customClass = args.customClass.replaceAll(","," ");
-    } else if ( typeof(args.customClass) === 'object' ) {
+    if (typeof args.customClass === "string") {
+      args.customClass = args.customClass.replaceAll(",", " ");
+    } else if (typeof args.customClass === "object") {
       args.customClass = args.customClass.join(" ");
     }
-  
+
     return new Select(args).html;
-  
   },
+  parameters: { backgrounds: { disable: false } },
+  globals: { backgrounds: { value: "default" } },
 
   //https://storybook.js.org/docs/api/arg-types
-  argTypes: {
-    /*customClass: {
-      name: "Classes",
-      description: 'Settable classes for the component',
-      control: {
-        type: "check",
-        labels: {
-          "form-style-filled": "Filled",
-        },
-      },
-      options: [
-        "form-style-filled",
-      ],
-    },
-    states: {
-      name: "States",
-      description: `Valid/Invalid states`,
-      control: {
-        type: "radio",
-        labels: {
-          "default": "Default",
-          "qld-input-success": "Success",
-          "qld-input-error": "Error",
-        },
-      },
-      options: [
-        "default",
-        "qld-input-success",
-        "qld-input-error",
-      ],
-    },*/
-  },
+  argTypes,
 };
 
 /**
- * Default textbox
+ * Default palette context
  */
 export const Default = {
   args: defaultdata,
 };
 
 /**
- * Dark themed textbox
+ * Dark pallete context
  */
 export const Dark = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: false},
-  },
-  parameters: {
-    backgrounds: {
-      default: 'Dark',
-      values: [
-        { name: 'Dark', value: 'var(--qld-brand-primary)' },
-      ],
-    },
+  args: {
+    ...defaultdata,
+    isDisabled: false,
   },
-  decorators: [
-    (Story) => {
-      return `
-      <div class="dark">
-          ${Story()}
-      </div>
-      `;
-    },
-  ],
+  globals: { backgrounds: { value: "dark" } },
+  render: (args) => `<div class="dark">${new Select(args).html}</div>`,
 };
 
 /**
- * Filled style select
+ * Add custom class `form-style-filled`
  */
 export const Filled = {
-  args: { 
-	  ...defaultdata,
-	  ...{customClass: "form-style-filled"},
+  args: {
+    ...defaultdata,
+    isFilled: "true",
   },
 };
 
-
-/**
- * Disabled select
- */
 export const Disabled = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: true},
+  args: {
+    ...defaultdata,
+    isDisabled: true,
   },
 };
 
-/**
- * Valid select
- */
 export const Valid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-success"},
+    ...defaultdata,
+    isValid: true,
   },
 };
 
-/**
- * Invalid select
- */
 export const Invalid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-error"},
+    ...defaultdata,
+    isValid: false,
   },
 };

package/src/components/bs5/select/select.data.json

@@ -1,12 +1,14 @@
 {
-	"isDisabled": false,
-	"isRequired": true,
-	"isFilled": false,
-	"customClass": "",
-	"label-text": "Label",
-	"placeholder": "Please select",
-	"optional-text": "optional",
-	"hint-text": "Hint",
-	"successMessageText": "Success message",
-	"errorMessageText": "Error message"
+  "id": "example-1",
+  "isDisabled": false,
+  "isRequired": true,
+  "isFilled": false,
+  "isValid": null,
+  "customClass": "",
+  "label-text": "Label",
+  "placeholder": "Please select",
+  "optional-text": "optional",
+  "hint-text": "Hint",
+  "successMessageText": "Success message",
+  "errorMessageText": "Error message"
 }

package/src/components/bs5/select/select.hbs

@@ -1,33 +1,33 @@
 <!-- QGDS Component: Select -->
 
-<!-- Label for the first input field -->
-<label class="qld-text-input-label {{#if isRequired}}field-required{{/if}} {{#if isDisabled}}field-disabled{{/if}}" for="example-1">
+<label class="qld-text-input-label {{#if isRequired}}field-required{{/if}} {{#if isDisabled}}field-disabled{{/if}}" for="{{id}}">
     {{label-text}}
     {{#if optional-text}}
-    <span class="label-text-optional">({{optional-text}})</span></label>
+    <span class="label-text-optional">({{optional-text}})</span>
     {{/if}}
+</label>
 
-<!-- Hint text for the first input field -->
 {{#if hint-text}}
-<span class="qld-hint-text" id="example-1-hint">{{hint-text}}</span>
+<span class="qld-hint-text" id="{{id}}-hint">{{hint-text}}</span>
 {{/if}}
 
-{{#contains "qld-input-success" customClass}}
-<span id="text-field-success" class="qld-input-success">
-    {{successMessageText}}
-</span>
-{{/contains}}
+{{#contains "qld-input-success" customClass}}{{! legacy support for feedback classes `qld-input-success`}}
+<span class="qld-input-success">{{successMessageText}}</span>
+{{else}}{{! updated bootstrap style classes - `valid-feedback`}}
+{{#if successMessageText}}
+<div class="valid-feedback">{{successMessageText}}</div>
+{{/if}}{{/contains}}
 
-{{#contains "qld-input-error" customClass}}
-<span id="text-field-error" class="qld-input-error">
-    {{errorMessageText}}
-</span>
-{{/contains}}
+{{#contains "qld-input-error" customClass}}{{! legacy support for feedback classes `qld-input-error`}}
+<span class="qld-input-error">{{errorMessageText}}</span>
+{{else}}{{! updated bootstrap style classes - `invalid-feedback`}}
+{{#if errorMessageText}}
+<div class="invalid-feedback">{{errorMessageText}}</div>
+{{/if}}{{/contains}}
 
-<!-- First text input field, described by the hint text above -->
-<select class="qld-text-input form-select qld-select qld-field-width-1-quarter {{customClass}}"
-    aria-label="Default select example" {{#if isDisabled}}disabled{{/if}} {{#if isRequired}}required aria-required="true"{{/if}}>
-    <option selected>{{placeholder}}</option>
+<select id={{id}} class="form-select {{#if isFilled}}is-filled{{/if}} {{#if isValid}}is-valid{{else}}{{#ifCond isValid "===" false}}is-invalid{{/ifCond}}{{/if}} {{customClass}}" 
+    {{#if hint-text}}aria-describedby="{{id}}-hint"{{/if}} {{#if isDisabled}}disabled{{/if}} {{#if isRequired}}required{{/if}} >
+    <option selected value="">{{placeholder}}</option>
     <option value="1">Option 1</option>
     <option value="2">Option 2</option>
     <option value="3">Option 3</option>

package/src/components/bs5/textarea/Textarea.js

@@ -1,13 +1,21 @@
-import Component from '../../../js/QGDSComponent.js'
+import Component from "../../../js/QGDSComponent.js";
 import template from "./textarea.hbs?raw";
 
 export class Textarea {
-
   // Use the global Component class to create a new instance of the Textarea component.
-  // A data object, containing the Handlebars placeholder replacement strings, should be provided as an argument. 
+  // A data object, containing the Handlebars placeholder replacement strings, should be provided as an argument.
 
-  constructor( data = {} ) {
+  constructor(data = {}) {
     return new Component(template, data);
   }
-
 }
+
+export const argTypes = {
+  isValid: {
+    description:
+      "For server-side validation, set to true or false. Omit or set to null to to indicate the input is yet to be validated.",
+    control: "radio",
+    options: [true, false, null],
+    type: "boolean | null",
+  },
+};

package/src/components/bs5/textarea/Textarea.stories.js

@@ -1,101 +1,75 @@
 // ComponentExample.stories.js
-import { Textarea } from "./Textarea.js";
+import { Textarea, argTypes } from "./Textarea.js";
 import defaultdata from "./textarea.data.json";
 
 export default {
   tags: ["autodocs"],
-  title: "3. Components/Forms/Textarea",
+  title: "3. Components/Forms/Text Area",
   render: (args) => {
-    
-    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc. 
+    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc.
     //We can't use commas on our class="..." attribute, so we need to replace the commas with spaces.
 
-    if( typeof(args.customClass) === 'string' ) {
-      args.customClass = args.customClass.replaceAll(","," ");
-    } else if ( typeof(args.customClass) === 'object' ) {
+    if (typeof args.customClass === "string") {
+      args.customClass = args.customClass.replaceAll(",", " ");
+    } else if (typeof args.customClass === "object") {
       args.customClass = args.customClass.join(" ");
     }
-  
+
     return new Textarea(args).html;
-  
   },
-
+  parameters: { backgrounds: { disable: false } },
+  globals: { backgrounds: { value: "default" } },
   //https://storybook.js.org/docs/api/arg-types
-  argTypes: {
-  },
+  argTypes,
 };
 
 /**
- * Default textarea
+ * Default palette
  */
 export const Default = {
   args: defaultdata,
 };
 
 /**
- * Dark themed textarea
+ * Dark palette
  */
 export const Dark = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: false},
-  },
-  parameters: {
-    backgrounds: {
-      default: 'Dark',
-      values: [
-        { name: 'Dark', value: 'var(--qld-brand-primary)' },
-      ],
-    },
+  args: {
+    ...defaultdata,
+    isDisabled: false,
   },
-  decorators: [
-    (Story) => {
-      return `
-      <div class="dark">
-          ${Story()}
-      </div>
-      `;
-    },
-  ],
+  globals: { backgrounds: { value: "dark" } },
+  render: (args) => `<div class="dark">${new Textarea(args).html}</div>`,
 };
 
 /**
- * Filled style textarea
+ * Add  `customClass: "form-style-filled"`
  */
 export const Filled = {
-  args: { 
-	  ...defaultdata,
-	  ...{customClass: "form-style-filled"},
+  args: {
+    ...defaultdata,
+    isFilled: true,
   },
 };
 
-
-/**
- * Disabled textarea
- */
 export const Disabled = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: true, isRequired: false},
+  args: {
+    ...defaultdata,
+    isDisabled: true,
+    isRequired: false,
   },
 };
 
-/**
- * Valid textbox
- */
 export const Valid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-success"},
+    ...defaultdata,
+    isValid: true,
   },
 };
 
-/**
- * Invalid textbox
- */
 export const Invalid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-error"},
+    ...defaultdata,
+    isValid: false,
   },
 };

package/src/components/bs5/textarea/textarea.data.json

@@ -1,13 +1,16 @@
 {
-	"isDisabled": false,
-	"isRequired": true,
-	"isFilled": false,
-	"customClass": "",
-	"rows": 3,
-	"label-text": "Label",
-	"placeholder": "Leave a comment here",
-	"optional-text": "optional",
-	"hint-text": "Hint",
-	"successMessageText": "Success message",
-	"errorMessageText": "Error message"
+  "id": "example-1",
+  "value": "",
+  "isDisabled": false,
+  "isRequired": true,
+  "isValid": null,
+  "isFilled": false,
+  "customClass": "",
+  "rows": 3,
+  "label-text": "Label",
+  "placeholder": "",
+  "optional-text": "optional",
+  "hint-text": "Hint",
+  "successMessageText": "Success message",
+  "errorMessageText": "Error message"
 }

package/src/components/bs5/textarea/textarea.hbs

@@ -1,32 +1,32 @@
 <!-- QGDS Component: Textarea -->
 
-<!-- Label for the first input field -->
 <label class="qld-text-input-label {{#if isRequired}}field-required{{/if}} {{#if isDisabled}}field-disabled{{/if}}"
-    for="example-1">
+    for="{{id}}">
     {{label-text}}
     {{#if optional-text}}
     <span class="label-text-optional">({{optional-text}})</span>
     {{/if}}
 </label>
 
-<!-- Hint text for the first input field -->
 {{#if hint-text}}
-<span class="qld-hint-text" id="example-1-hint">{{hint-text}}</span>
+<span class="qld-hint-text" id="{{id}}-hint">{{hint-text}}</span>
 {{/if}}
 
-{{#contains "qld-input-success" customClass}}
-<span id="text-field-success" class="qld-input-success">
-    {{successMessageText}}
-</span>
-{{/contains}}
+{{#contains "qld-input-success" customClass}}{{! legacy support for feedback classes `qld-input-success`}}
+<span class="qld-input-success">{{successMessageText}}</span>
+{{else}}
+{{#if successMessageText}}{{! updated bootstrap style classes - `valid-feedback`}}
+<div class="valid-feedback">{{successMessageText}}</div>
+{{/if}}{{/contains}}
 
-{{#contains "qld-input-error" customClass}}
-<span id="text-field-error" class="qld-input-error">
-    {{errorMessageText}}
-</span>
-{{/contains}}
+{{#contains "qld-input-error" customClass}}{{! legacy support for feedback classes `qld-input-error`}}
+<span class="qld-input-error">{{errorMessageText}}</span>
+{{else}}
+{{#if errorMessageText}}{{! updated bootstrap style classes - `invalid-feedback`}}
+<div class="invalid-feedback">{{errorMessageText}}</div>
+{{/if}}{{/contains}}
 
 <!-- First text input field, described by the hint text above -->
-<textarea id="example-1" class="qld-text-input form-control {{customClass}} {{#if isFilled}}form-style-filled{{/if}}"
-    placeholder="{{placeholder}}" rows="{{rows}}" {{#if isDisabled}}disabled{{/if}} {{#if isRequired}}required
-    aria-required="true" {{/if}}></textarea>
+<textarea id="{{id}}" class="form-control {{customClass}} {{#if isFilled}}is-filled{{/if}} {{#if isValid}}is-valid{{else}}{{#ifCond isValid "===" false}}is-invalid{{/ifCond}}{{/if}}"
+    placeholder="{{placeholder}}" rows="{{rows}}" {{#if isDisabled}}disabled{{/if}} {{#if isRequired}}required{{/if}}
+    {{#if hint-text}}aria-describedby="{{id}}-hint"{{/if}}>{{value}}</textarea>

package/src/components/bs5/textbox/Textbox.js

@@ -1,13 +1,24 @@
-import Component from '../../../js/QGDSComponent.js'
+import Component from "../../../js/QGDSComponent.js";
 import template from "./textbox.hbs?raw";
 
+/**
+ * Named `Text input` in Design system.
+ */
 export class Textbox {
-
   // Use the global Component class to create a new instance of the Textbox component.
-  // A data object, containing the Handlebars placeholder replacement strings, should be provided as an argument. 
+  // A data object, containing the Handlebars placeholder replacement strings, should be provided as an argument.
 
-  constructor( data = {} ) {
+  constructor(data = {}) {
     return new Component(template, data);
   }
-
 }
+
+export const argTypes = {
+  isValid: {
+    description:
+      "For server-side validation, set to true or false. Omit or set to null to to indicate the input is yet to be validated.",
+    control: "radio",
+    options: [true, false, null],
+    type: "boolean | null",
+  },
+};

package/src/components/bs5/textbox/Textbox.stories.js

@@ -1,45 +1,26 @@
 // ComponentExample.stories.js
-import { Textbox } from "./Textbox.js";
+import { Textbox, argTypes } from "./Textbox.js";
 import defaultdata from "./textbox.data.json";
 
 export default {
   tags: ["autodocs"],
-  title: "3. Components/Forms/Textbox",
+  title: "3. Components/Forms/Text input",
   render: (args) => {
-    
-    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc. 
+    //Storybook produces a comma delimited string when using the check control type (table-striped, table-bordered) etc.
     //We can't use commas on our class="..." attribute, so we need to replace the commas with spaces.
 
-    if( typeof(args.customClass) === 'string' ) {
-      args.customClass = args.customClass.replaceAll(","," ");
-    } else if ( typeof(args.customClass) === 'object' ) {
+    if (typeof args.customClass === "string") {
+      args.customClass = args.customClass.replaceAll(",", " ");
+    } else if (typeof args.customClass === "object") {
       args.customClass = args.customClass.join(" ");
     }
-  
+
     return new Textbox(args).html;
-  
   },
-
+  parameters: { backgrounds: { disable: false } },
+  globals: { backgrounds: { value: "default" } },
   //https://storybook.js.org/docs/api/arg-types
-  argTypes: {
-    states: {
-      name: "States",
-      description: `Valid/Invalid states`,
-      control: {
-        type: "radio",
-        labels: {
-          "default": "Default",
-          "qld-input-success": "Success",
-          "qld-input-error": "Error",
-        },
-      },
-      options: [
-        "default",
-        "qld-input-success",
-        "qld-input-error",
-      ],
-    },
-  },
+  argTypes,
 };
 
 /**
@@ -53,18 +34,11 @@ export const Default = {
  * Dark themed textbox
  */
 export const Dark = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: false},
-  },
-  parameters: {
-    backgrounds: {
-      default: 'Dark',
-      values: [
-        { name: 'Dark', value: 'var(--qld-brand-primary)' },
-      ],
-    },
+  args: {
+    ...defaultdata,
+    ...{ isDisabled: false },
   },
+  globals: { backgrounds: { value: "dark" } },
   decorators: [
     (Story) => {
       return `
@@ -80,20 +54,19 @@ export const Dark = {
  * Filled style textbox
  */
 export const Filled = {
-  args: { 
-	  ...defaultdata,
-	  ...{customClass: "form-style-filled"},
+  args: {
+    ...defaultdata,
+    customClass: "form-style-filled",
   },
 };
 
-
 /**
  * Disabled textbox
  */
 export const Disabled = {
-  args: { 
-	  ...defaultdata,
-	  ...{isDisabled: true},
+  args: {
+    ...defaultdata,
+    isDisabled: true,
   },
 };
 
@@ -102,8 +75,9 @@ export const Disabled = {
  */
 export const Valid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-success"},
+    ...defaultdata,
+    isValid: true,
+    // ...{ customClass: "qld-input-success" },
   },
 };
 
@@ -112,7 +86,8 @@ export const Valid = {
  */
 export const Invalid = {
   args: {
-	  ...defaultdata,
-    ...{customClass: "qld-input-error"},
+    ...defaultdata,
+    isValid: false,
+    // ...{ customClass: "qld-input-error" },
   },
 };