@qld-gov-au/qgds-bootstrap5 2.0.10 → 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/tag/tag--status.stories.js

@@ -42,6 +42,7 @@ function statusVariantsMarkup() {
           //Generate Tag component markup from all possible tag types.
           const tagHtml = new Tag({
             variant: defaultdata.status.variant,
+            classes: "p-4 my-2",
             tagItems: tagItems,
             size: sizeClass,
             emphasis: emClass,

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

@@ -1,145 +1,151 @@
 {
-	"default": {
-		"variant": "tag-default",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "Tag text"
-			},
-			{
-				"id": "Two",
-				"content": "Tag text"
-			},
-			{
-				"id": "Three",
-				"content": "Tag text"
-			},
-			{
-				"id": "Four",
-				"content": "Tag text"
-			}
-		]
-	},
-	"large": {
-		"variant": "",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "Tag text",
-				"classes": "tag-large"
-			},
-			{
-				"id": "Two",
-				"content": "Tag text",
-				"classes": "tag-large"
-			},
-			{
-				"id": "Three",
-				"content": "Tag text",
-				"classes": "tag-large"
-			}
-		]
-	},
-	"action": {
-		"variant": "",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "<a href='javascript:void(0)'>Tag text</a>",
-				"classes": "tag-link"
-			},
-			{
-				"id": "Two",
-				"content": "<a href='javascript:void(0)'>Tag text</a>",
-				"classes": "tag-link"
-			},
-			{
-				"id": "Three",
-				"content": "<a href='javascript:void(0)'>Tag text</a>",
-				"classes": "tag-link"
-			}
-		]
-	},
-	"dark": {
-		"classes": "",
-		"variant": "tag-dark",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "Tag text"
-			},
-			{
-				"id": "Two",
-				"content": "Tag text"
-			},
-			{
-				"id": "Three",
-				"content": "Tag text"
-			}
-		]
-	},
-	"info": {
-		"variant": "",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "Tag text",
-				"classes": "tag-info"
-			},
-			{
-				"id": "Two",
-				"content": "Tag text",
-				"classes": "tag-info"
-			},
-			{
-				"id": "Three",
-				"content": "Tag text",
-				"classes": "tag-info"
-			}
-		]
-	},
-	"filter": {
-		"variant": "",
-		"tagItems": [
-			{
-				"id": "One",
-				"content": "Policies and procedures",
-				"classes": "tag-large",
-				"applied-filter": true
-			},
-			{
-				"id": "Two",
-				"content": "Publications",
-				"classes": "tag-large",
-				"applied-filter": true
-			}
-		]
-	},
-	"status": {
-		"variant": "tag-status",
-		"tagItems": [
-			{
-				"content": "Neutral",
-				"classes": "tag-neutral"
-			},
-			{
-				"content": "Success",
-				"classes": "tag-success"
-			},
-			{
-				"content": "Warning",
-				"classes": "tag-warning"
-			},
-			{
-				"content": "Error",
-				"classes": "tag-error"
-			},
-			{
-				"content": "Information",
-				"classes": "tag-information"
-			}
-		],
-		"size": "tag-small",
-		"emphasis": "tag-low"
-	}
+  "default": {
+    "variant": "tag-default",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "Tag text"
+      },
+      {
+        "id": "Two",
+        "content": "Tag text"
+      },
+      {
+        "id": "Three",
+        "content": "Tag text"
+      },
+      {
+        "id": "Four",
+        "content": "Tag text"
+      }
+    ]
+  },
+  "large": {
+    "variant": "",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "Tag text",
+        "classes": "tag-large"
+      },
+      {
+        "id": "Two",
+        "content": "Tag text",
+        "classes": "tag-large"
+      },
+      {
+        "id": "Three",
+        "content": "Tag text",
+        "classes": "tag-large"
+      }
+    ]
+  },
+  "action": {
+    "variant": "",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "<a href='javascript:void(0)'>Tag text</a>",
+        "classes": "tag-link"
+      },
+      {
+        "id": "Two",
+        "content": "<a href='javascript:void(0)'>Tag text</a>",
+        "classes": "tag-link"
+      },
+      {
+        "id": "Three",
+        "content": "<a href='javascript:void(0)'>Tag text</a>",
+        "classes": "tag-link"
+      }
+    ]
+  },
+  "dark": {
+    "classes": "p-4 my-2",
+    "variant": "tag-dark",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "Tag text"
+      },
+      {
+        "id": "Two",
+        "content": "Tag text"
+      },
+      {
+        "id": "Three",
+        "content": "Tag text"
+      }
+    ]
+  },
+  "info": {
+    "variant": "",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "Tag text",
+        "classes": "tag-info"
+      },
+      {
+        "id": "Two",
+        "content": "Tag text",
+        "classes": "tag-info"
+      },
+      {
+        "id": "Three",
+        "content": "Tag text",
+        "classes": "tag-info"
+      }
+    ]
+  },
+  "filter": {
+    "variant": "",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "id": "One",
+        "content": "Policies and procedures",
+        "classes": "tag-large",
+        "applied-filter": true
+      },
+      {
+        "id": "Two",
+        "content": "Publications",
+        "classes": "tag-large",
+        "applied-filter": true
+      }
+    ]
+  },
+  "status": {
+    "variant": "tag-status",
+    "classes": "p-4 my-2",
+    "tagItems": [
+      {
+        "content": "Neutral",
+        "classes": "tag-neutral"
+      },
+      {
+        "content": "Success",
+        "classes": "tag-success"
+      },
+      {
+        "content": "Warning",
+        "classes": "tag-warning"
+      },
+      {
+        "content": "Error",
+        "classes": "tag-error"
+      },
+      {
+        "content": "Information",
+        "classes": "tag-information"
+      }
+    ],
+    "size": "tag-small",
+    "emphasis": "tag-low"
+  }
 }

package/src/components/bs5/tag/tag.hbs

@@ -1,6 +1,6 @@
 <!-- QGDS Component: Tag -->
 
-<ul class="tag-list {{variant}}">
+<ul class="tag-list {{variant}} {{classes}}">
   {{#each tagItems}}
     <li class="tag-item {{classes}} {{../size}} {{../emphasis}}">
       {{{content}}}

package/src/components/bs5/tag/tag.scss

@@ -91,9 +91,8 @@ $_icon-status-cancel: url('data:image/svg+xml,<svg width="32" height="32" viewBo
 // General styling rules.
 .tag-list {
   list-style-type: none;
-  margin: 0.5rem 0;
-  padding: 30px;
   display: flex;
+  flex-wrap: wrap;
   align-items: center;
   gap: 1rem;
 
@@ -114,9 +113,7 @@ $_icon-status-cancel: url('data:image/svg+xml,<svg width="32" height="32" viewBo
     border: var(--_border-width) solid var(--#{$prefix}neutral-lighter);
     border-radius: 1rem;
     font-size: 0.875rem;
-    line-height: 1.5;
-
-    height: var(--_height);
+    line-height: 1.4;
 
     &.tag-large {
       --_padding-y: 0.5rem;

package/src/components/bs5/tag/tag.stories.js

@@ -45,6 +45,7 @@ export const ParentContextComparison = {
   render: () => {
     const testTags = {
       variant: "",
+      classes: "p-4 my-2",
       tagItems: [
         {
           content: "default",

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",
+  },
+};