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

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

package/src/components/bs5/textbox/textInput.scss

@@ -1,7 +1,7 @@
+@use "../../../css/functions" as f;
+
 .qld-text-input {
-  padding: 12px 16px;
-  border-radius: 4px;
-  border: 2px solid $qld-soft-grey;
+  @extend %form-control;
 
   @media (prefers-color-scheme: dark) {
     --table-row-border-color: var(--qld-white);
@@ -9,44 +9,18 @@
 
   //Table dark
   @include table-variant("dark", $qld-brand-primary);
-
-  &:hover {
-    background-color: $qld-extra-light-grey;
-    border-color: $qld-textbox-border-color;
-  }
-
-  &:focus {
-    outline: 3px solid $qld-light-blue;
-    outline-offset: 2px;
-    background-color: $qld-white !important;
-    border: 2px solid $qld-light-grey !important;
-  }
-
-  &.form-style-filled {
-    background-color: $qld-light-grey-alt;
-    border-width: 0 0 2px 0;
-    border-bottom-left-radius: 0;
-    border-bottom-right-radius: 0;
-
-    &:focus {
-      border-radius: 4px;
-    }
-  }
-
-  &:disabled {
-    cursor: not-allowed;
-    opacity: 0.5;
-  }
 }
 
 .qld-text-input-label {
   color: var(--#{$prefix}text-grey);
   display: block;
+  font-size: 1rem;
   font-weight: 600;
-  line-height: 1.5;
-  margin-bottom: 0.5rem;
+  line-height: $input-line-height;
+  margin-bottom: f.remify(8px);
 
   .label-text-optional {
+    font-size: f.remify(14px);
     color: $qld-dark-grey-muted;
     font-weight: 400;
   }
@@ -64,146 +38,19 @@
   }
 }
 
-* + .qld-hint-text,
-* + .qld-input-error,
-* + .qld-input-success,
 * + .date-container {
-  margin-top: 8px;
+  margin-top: f.remify(4px);
 }
 
 .qld-hint-text {
   color: $qld-hint-text-color;
   display: block;
-  font-size: 1em;
-  line-height: 1.5;
-  margin-bottom: 0.5rem;
-}
-
-* + p.qld-input-error,
-* + span.qld-input-error,
-* + p.qld-input-success,
-* + span.qld-input-success {
-  font-size: 1rem;
-  line-height: 1.5;
-  display: flex;
-  flex-wrap: wrap;
-  margin-left: -6px;
-  align-items: center;
-}
-
-span.qld-input-success {
-  &:before {
-    content: "";
-    height: 2rem;
-    width: 2rem;
-    transform: scale(0.6);
-    background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 64 64' enable-background='new 0 0 64 64'%3E%3Cpath d='M32,2C15.431,2,2,15.432,2,32c0,16.568,13.432,30,30,30c16.568,0,30-13.432,30-30C62,15.432,48.568,2,32,2z M25.025,50 l-0.02-0.02L24.988,50L11,35.6l7.029-7.164l6.977,7.184l21-21.619L53,21.199L25.025,50z' fill='%2343a047'/%3E%3C/svg%3E");
-  }
-}
-
-span.qld-input-error {
-  color: $qld-notify-warning;
-
-  &:before {
-    content: "";
-    height: 2rem;
-    width: 2rem;
-    //background-image: url('../../../img/icon-exclamation.svg');
-    background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M24 12C24 18.6274 18.6274 24 12 24C5.37258 24 0 18.6274 0 12C0 5.37258 5.37258 0 12 0C18.6274 0 24 5.37258 24 12Z' fill='%23E22339'/%3E%3Cpath d='M11 18C11 17.4477 11.4477 17 12 17C12.5523 17 13 17.4477 13 18C13 18.5523 12.5523 19 12 19C11.4477 19 11 18.5523 11 18Z' fill='white'/%3E%3Cpath d='M11 5C11 4.44771 11.4477 4 12 4C12.5523 4 13 4.44772 13 5V14C13 14.5523 12.5523 15 12 15C11.4477 15 11 14.5523 11 14V5Z' fill='white'/%3E%3C/svg%3E");
-    background-repeat: no-repeat;
-    transform: scale(0.6);
-  }
-
-  .dark & {
-    color: $qld-color-error-light;
-  }
-}
-
-.qld-hint-text + select,
-.qld-hint-text + input,
-.qld-hint-text + textarea,
-.sq-form-question-note + select,
-.sq-form-question-note + input,
-.sq-form-question-note + textarea {
-  margin-top: 0.5rem;
-}
-
-.qld-input-success + input[type="text"],
-.qld-input-error + input[type="text"],
-.qld-input-success + input[type="email"],
-.qld-input-error + input[type="email"],
-.qld-input-success + input[type="date"],
-.qld-input-error + input[type="date"],
-.qld-input-success + .qld-text-input,
-.qld-input-error + .qld-text-input,
-.qld-input-success + textarea,
-.qld-input-error + textarea {
-  margin-top: 8px;
-  margin-top: 0.5rem;
-}
-
-input.qld-text-input.qld-input-error:not(:focus),
-input.qld-text-input.qld-input-error.form-style-filled:not(:focus),
-textarea.qld-text-input.qld-input-error:not(:focus),
-select.qld-select.qld-input-error:not(:focus) {
-  border-color: $qld-notify-warning;
-  background-color: $qld-color-error-light;
-  color: $qld-text-grey;
-}
-
-input.qld-text-input.qld-input-success:not(:focus),
-input.qld-text-input.qld-input-success.form-style-filled:not(:focus),
-textarea.qld-text-input.qld-input-success:not(:focus),
-select.qld-select.qld-input-success:not(:focus) {
-  border-color: $qld-notify-success;
-  background-color: $qld-color-success-light;
-  color: $qld-text-grey;
-}
-
-.qld-select {
-  padding: 12px 18px;
-  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='%23008635' d='M4.251 181.1C7.392 177.7 11.69 175.1 16 175.1c3.891 0 7.781 1.406 10.86 4.25l197.1 181.1l197.1-181.1c6.5-6 16.64-5.625 22.61 .9062c6 6.5 5.594 16.59-.8906 22.59l-208 192c-6.156 5.688-15.56 5.688-21.72 0l-208-192C-1.343 197.7-1.749 187.6 4.251 181.1z'/%3E%3C/svg%3E");
-  background-repeat: no-repeat;
-  appearance: none;
-  background-position: right 11px center;
-  background-size: 1rem auto;
-  width: 100%;
-  color: var(--#{$prefix}color-default-color-light-text-lighter);
-
-  &.disabled,
-  &:disabled {
-    background-color: var(
-      --#{$prefix}color-default-color-light-background-default-shade
-    );
-    background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='%23636363' d='M4.251 181.1C7.392 177.7 11.69 175.1 16 175.1c3.891 0 7.781 1.406 10.86 4.25l197.1 181.1l197.1-181.1c6.5-6 16.64-5.625 22.61 .9062c6 6.5 5.594 16.59-.8906 22.59l-208 192c-6.156 5.688-15.56 5.688-21.72 0l-208-192C-1.343 197.7-1.749 187.6 4.251 181.1z'/%3E%3C/svg%3E");
-  }
-
-  &.qld-input-error {
-    background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='%23E22339' d='M4.251 181.1C7.392 177.7 11.69 175.1 16 175.1c3.891 0 7.781 1.406 10.86 4.25l197.1 181.1l197.1-181.1c6.5-6 16.64-5.625 22.61 .9062c6 6.5 5.594 16.59-.8906 22.59l-208 192c-6.156 5.688-15.56 5.688-21.72 0l-208-192C-1.343 197.7-1.749 187.6 4.251 181.1z'/%3E%3C/svg%3E");
-
-    &:not([multiple]):not([size]),
-    &:not([multiple])[size="1"] {
-      background-size: 1rem auto;
-    }
-  }
-
-  &.qld-input-success {
-    background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='%23339d37' d='M4.251 181.1C7.392 177.7 11.69 175.1 16 175.1c3.891 0 7.781 1.406 10.86 4.25l197.1 181.1l197.1-181.1c6.5-6 16.64-5.625 22.61 .9062c6 6.5 5.594 16.59-.8906 22.59l-208 192c-6.156 5.688-15.56 5.688-21.72 0l-208-192C-1.343 197.7-1.749 187.6 4.251 181.1z'/%3E%3C/svg%3E");
-
-    &:not([multiple]):not([size]),
-    &:not([multiple])[size="1"] {
-      background-size: 1rem auto;
-    }
-  }
+  font-size: f.remify(14px);
+  line-height: f.snap-line-height(1.5);
+  margin-block: f.remify(8px);
 }
 
-.qld-input-success {
-  @extend .is-valid;
-}
-
-.qld-input-error {
-  @extend .is-invalid;
-}
+// .qld-select style moved to formcheck.scss
 
 @include media-breakpoint-up(md) {
   input.qld-field-width-1-quarter,
@@ -223,73 +70,6 @@ select.qld-select.qld-input-success:not(:focus) {
 }
 
 .dark {
-  .form-control.qld-text-input:not(:hover):not(:focus):not(
-      .qld-input-error
-    ):not(.qld-input-success)::-webkit-input-placeholder {
-    color: $qld-hint-text-color-muted;
-  }
-
-  .form-control.qld-text-input:not(:hover):not(:focus):not(
-      .qld-input-error
-    ):not(.qld-input-success)::-moz-placeholder {
-    color: $qld-hint-text-color-muted;
-  }
-
-  .form-control.qld-text-input:not(:hover):not(:focus):not(
-      .qld-input-error
-    ):not(.qld-input-success)::-ms-placeholder {
-    color: $qld-hint-text-color-muted;
-  }
-
-  .form-control.qld-text-input:not(:hover):not(:focus):not(
-      .qld-input-error
-    ):not(.qld-input-success)::placeholder {
-    color: $qld-hint-text-color-muted;
-  }
-
-  .form-control.qld-text-input:hover:not(:focus):not(.qld-input-error):not(
-      .qld-input-success
-    )::-webkit-input-placeholder {
-    color: $qld-white;
-  }
-
-  .form-control.qld-text-input:hover:not(:focus):not(.qld-input-error):not(
-      .qld-input-success
-    )::-moz-placeholder {
-    color: $qld-white;
-  }
-
-  .form-control.qld-text-input:hover:not(:focus):not(.qld-input-error):not(
-      .qld-input-success
-    )::-ms-placeholder {
-    color: $qld-white;
-  }
-
-  .form-control.qld-text-input:hover:not(:focus):not(.qld-input-error):not(
-      .qld-input-success
-    )::placeholder {
-    color: $qld-white;
-  }
-}
-
-.dark {
-  .qld-text-input {
-    border-color: $qld-dark-alt-border;
-    background-color: var(--qld-dark-background);
-    color: $qld-hint-text-color-muted;
-
-    &:hover {
-      color: $qld-white;
-      background-color: $qld-color-dark-background--shade;
-      border-color: $color-default-color-dark-action-primary-hover;
-    }
-
-    &:focus {
-      outline: 3px solid $qld-dark-focus;
-      color: $qld-text-grey;
-    }
-  }
-
   .qld-select {
     background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='%23FFEF60' d='M4.251 181.1C7.392 177.7 11.69 175.1 16 175.1c3.891 0 7.781 1.406 10.86 4.25l197.1 181.1l197.1-181.1c6.5-6 16.64-5.625 22.61 .9062c6 6.5 5.594 16.59-.8906 22.59l-208 192c-6.156 5.688-15.56 5.688-21.72 0l-208-192C-1.343 197.7-1.749 187.6 4.251 181.1z'/%3E%3C/svg%3E");
   }

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

@@ -1,12 +1,15 @@
 {
-	"isDisabled": false,
-	"isRequired": true,
-	"isFilled": false,
-	"customClass": "",
-	"label-text": "Label",
-	"placeholder": "Hello World",
-	"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": "",
+  "label-text": "Label",
+  "placeholder": "",
+  "optional-text": "optional",
+  "hint-text": "Hint",
+  "successMessageText": "Success message",
+  "errorMessageText": "Error message"
 }