Merge pull request #343 from deven-org/feat/textarea-storybook

Feat(ui-library): add storybook storie examples
deven-org · Sep 26, 2023 · db5eb5e · db5eb5e
2 parents 248506e + b674d90
commit db5eb5e
Show file tree

Hide file tree

Showing 4 changed files with 301 additions and 10 deletions.
diff --git a/packages/ui-library/src/components/text-input/index.ts b/packages/ui-library/src/components/text-input/index.ts
@@ -92,7 +92,7 @@ export class BlrTextInput extends LitElement {
             class="blr-form-element ${inputClasses}"
             id=${this.textInputId}
             type="${this.currentType}"
-            value="${this.value}"
+            .value="${this.value}"
             placeholder="${this.placeholder}"
             ?disabled="${this.disabled}"
             ?readonly="${this.readonly}"

diff --git a/packages/ui-library/src/components/textarea/examples.stories.ts b/packages/ui-library/src/components/textarea/examples.stories.ts
@@ -0,0 +1,278 @@
+import { html } from 'lit-html';
+import { BlrTextareaRenderFunction, BlrTextareaType } from './index';
+import './index';
+
+const defaultParams: BlrTextareaType = {
+  theme: 'Light',
+  textareaId: '#1',
+  label: 'Label',
+  labelAppendix: '(Optional)',
+  size: 'md',
+  value: 'Rindfleischetikettierungsüberwachungsaufgabenübertragunsgesetz',
+  maxLength: 140,
+  warningLimitType: 'warningLimitInt',
+  warningLimitInt: 105,
+  warningLimitPer: 75,
+  cols: 20,
+  rows: 5,
+  shouldFocus: false,
+
+  placeholder: 'Type your message here ..',
+  required: false,
+  disabled: false,
+  readonly: false,
+
+  showHint: true,
+  hintIcon: 'blrInfo',
+  hintText: 'hint message',
+
+  hasError: false,
+  errorMessage: "OMG it's an error",
+
+  isResizeable: true,
+};
+
+interface StorybookTextareaType extends BlrTextareaType {
+  storybookLabel: string;
+}
+
+const fontStyle = html`
+  <style>
+    @import url('https://fonts.googleapis.com/css2?family=Source+Sans+Pro&display=swap');
+    @import url('https://fonts.googleapis.com/css2?family=Source+Code+Pro&display=swap');
+  </style>
+`;
+
+export default {
+  title: 'Design System/Web Components/BlrTextarea/Examples',
+  parameters: {
+    viewMode: 'story',
+    previewTabs: {
+      'storybook/docs/panel': {
+        hidden: true,
+      },
+    },
+  },
+  argTypes: {
+    placeholder: {
+      name: 'Placeholder',
+      description: 'Defines a short hint intended to aid the user with data entry when the component has no value.',
+      defaultValue: '',
+      control: {
+        type: 'text',
+        label: 'Enter Text',
+      },
+    },
+  },
+};
+
+const renderTextareaExample = (params: StorybookTextareaType) => html`
+  <div class="story-textarea">
+    <p>${params.storybookLabel}</p>
+    ${BlrTextareaRenderFunction(params)}
+  </div>
+`;
+
+export const Example1 = () => {
+  return html`
+    ${fontStyle}
+    <style>
+      .wrapper {
+        font-family: 'Source Sans Pro', 'Source Code Pro', sans-serif;
+        display: flex;
+        width: 100%;
+        flex-wrap: wrap;
+      }
+      .stories-textarea {
+        display: flex;
+        flex-wrap: wrap;
+        flex-direction: column;
+      }
+      .story-textarea {
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        gap: 1rem;
+        width: 20rem;
+      }
+      .column {
+        display: flex;
+        flex-direction: column;
+      }
+    </style>
+    <div class="wrapper">
+      <div class="column">
+        <p style="text-align: center">Default</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Focus', theme: 'Light', shouldFocus: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Disabled', theme: 'Light', disabled: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'readOnly', theme: 'Light', readonly: true })}
+        </div>
+      </div>
+      <div class="column">
+        <p style="text-align: center">Error</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({
+            ...defaultParams,
+            storybookLabel: 'Focus',
+            hasError: true,
+            theme: 'Light',
+            shouldFocus: true,
+          })}
+        </div>
+      </div>
+    </div>
+  `;
+};
+Example1.parameters = {
+  backgrounds: {
+    default: 'light',
+  },
+};
+
+Example1.storyName = 'Textarea Examples Light Theme Focus Error';
+
+export const Example4 = () => {
+  return html`
+    ${fontStyle}
+    <style>
+      .wrapper {
+        font-family: 'Source Sans Pro', 'Source Code Pro', sans-serif;
+        display: flex;
+        width: 100%;
+        flex-wrap: wrap;
+      }
+      .stories-textarea {
+        display: flex;
+        flex-wrap: wrap;
+        flex-direction: column;
+      }
+      .story-textarea {
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        gap: 1rem;
+        width: 20rem;
+      }
+      .column {
+        display: flex;
+        flex-direction: column;
+      }
+    </style>
+    <div class="wrapper">
+      <div class="column">
+        <p style="text-align: center">Default</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Focus', theme: 'Light', shouldFocus: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Disabled', theme: 'Light', disabled: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'readOnly', theme: 'Light', readonly: true })}
+        </div>
+      </div>
+      <div class="column">
+        <p style="text-align: center">Error</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', hasError: true, theme: 'Light' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Focus', hasError: true, theme: 'Light' })}
+        </div>
+      </div>
+    </div>
+  `;
+};
+Example4.parameters = {
+  backgrounds: {
+    default: 'light',
+  },
+};
+
+Example4.storyName = 'Textarea Examples Light Theme Focus Default';
+
+export const Example2 = () =>
+  html`
+    ${fontStyle}
+    <style>
+      .wrapper {
+        font-family: 'Source Sans Pro', 'Source Code Pro', sans-serif;
+        display: flex;
+        width: 100%;
+        flex-wrap: wrap;
+      }
+
+      .stories-textarea {
+        display: flex;
+        color: white;
+        flex-wrap: wrap;
+        flex-direction: column;
+      }
+
+      .story-textarea {
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        gap: 1rem;
+        width: 20rem;
+      }
+      .column {
+        display: flex;
+        flex-direction: column;
+      }
+    </style>
+    <div class="wrapper">
+      <div class="column">
+        <p style="text-align: center; color: white">Default</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', theme: 'Dark' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', theme: 'Dark' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', theme: 'Dark' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Focus', theme: 'Dark', shouldFocus: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Disabled', theme: 'Dark', disabled: true })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'readOnly', theme: 'Dark', readonly: true })}
+        </div>
+      </div>
+      <div class="column">
+        <p style="text-align: center; color: white">Error</p>
+        <div class="stories-textarea">
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Rest', hasError: true, theme: 'Dark' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Hover', hasError: true, theme: 'Dark' })}
+          ${renderTextareaExample({ ...defaultParams, storybookLabel: 'Pressed', hasError: true, theme: 'Dark' })}
+          ${renderTextareaExample({
+            ...defaultParams,
+            storybookLabel: 'Focus',
+            hasError: true,
+            theme: 'Dark',
+            shouldFocus: true,
+          })}
+        </div>
+      </div>
+    </div>
+  `;
+(Example2.parameters = {
+  backgrounds: {
+    default: 'dark',
+  },
+}),
+  (Example2.storyName = 'Textarea Examples Dark Theme');
+
+export const InteractivePlaceholder = ({ placeholder }) =>
+  html`
+    ${fontStyle}
+    ${BlrTextareaRenderFunction({
+      ...defaultParams,
+      placeholder: placeholder,
+      value: '',
+    })}
+  `;
+InteractivePlaceholder.storyName = 'Interaktiver Placeholder';
+InteractivePlaceholder.args = {
+  placeholder: defaultParams.placeholder,
+};
diff --git a/packages/ui-library/src/components/textarea/index.stories.ts b/packages/ui-library/src/components/textarea/index.stories.ts
@@ -9,7 +9,7 @@ import { Themes } from '../../foundation/_tokens-generated/index.themes';
 import { PureIconKeys } from '@boiler/icons';
 
 export default {
-  title: 'Design System/Web Components',
+  title: 'Design System/Web Components/BlrTextarea',
   argTypes: {
     size: {
       options: FormSizes,
@@ -121,7 +121,7 @@ export const BlrTextarea = ({
     })}
   `;
 
-BlrTextarea.storyName = 'BlrTextarea';
+BlrTextarea.storyName = 'BlrTextarea-Docs';
 
 BlrTextarea.args = {
   theme: 'Light',

diff --git a/packages/ui-library/src/components/textarea/index.ts b/packages/ui-library/src/components/textarea/index.ts
@@ -42,13 +42,22 @@ export class BlrTextarea extends LitElement {
   @property() rows?: number;
   @property() cols?: number;
   @property() onSelect?: HTMLElement['onselect'];
+  @property() shouldFocus? = false;
 
   @property() theme: ThemeType = 'Light';
 
   @state() protected count = 0;
-
   @query('textarea') protected textareaElement: HTMLTextAreaElement | undefined;
 
+  firstUpdated() {
+    if (this.shouldFocus) {
+      const textarea = this.shadowRoot?.querySelector('textarea');
+      if (textarea) {
+        textarea.focus();
+      }
+    }
+  }
+
   connectedCallback() {
     super.connectedCallback();
 
@@ -97,6 +106,7 @@ export class BlrTextarea extends LitElement {
       [`error-input`]: this.hasError || false,
       [`${this.size}`]: this.size,
       [`resizeable`]: this.isResizeable || false,
+      ['shouldFocus']: this.shouldFocus || false,
     });
 
     const counterVariant = this.determinateCounterVariant();
@@ -124,10 +134,13 @@ export class BlrTextarea extends LitElement {
             placeholder="${this.placeholder || nothing}"
             ?required="${this.required}"
             ?disabled="${this.disabled}"
+            ?readonly="${this.readonly}"
             @input="${this.onChange}"
-            @focus="${this.onFocus}"
+            @focus=${this.focus}
+            @blur=${this.blur}
             @select="${this.onSelect}"
             @keyup="${this.updateCounter}"
+            shouldFocus="${this.shouldFocus}"
           >${this.value}</textarea>
         </div>
         <div class="hint-wrapper">
@@ -163,8 +176,8 @@ export class BlrTextarea extends LitElement {
     `;
   }
 }
-
-export type BlrTextareaType = Omit<BlrTextarea, keyof LitElement>;
+type OmittedKeys = 'firstUpdated';
+export type BlrTextareaType = Omit<BlrTextarea, keyof LitElement | OmittedKeys>;
 
 export const BlrTextareaRenderFunction = ({
   textareaId,
@@ -185,13 +198,13 @@ export const BlrTextareaRenderFunction = ({
   hintIcon,
   hasError,
   onChange,
-  onFocus,
   onSelect,
   readonly,
   isResizeable,
   showHint,
   value,
   theme,
+  shouldFocus,
 }: BlrTextareaType) => {
   return html`<blr-textarea
     class=${isResizeable ? nothing : `parent-width`}
@@ -209,16 +222,16 @@ export const BlrTextareaRenderFunction = ({
     .placeholder="${placeholder}"
     .required=${required}
     .disabled=${disabled}
-    .readOnly=${readonly}
+    .readonly=${readonly}
     .hintText=${hintText}
     .hintIcon=${hintIcon}
     .hasError=${hasError}
     .labelAppendix=${labelAppendix}
     .onChange=${onChange}
-    .onFocus=${onFocus}
     .onSelect=${onSelect}
     .isResizeable=${isResizeable}
     .showHint=${showHint}
     .theme=${theme}
+    .shouldFocus=${shouldFocus}
   ></blr-textarea>`;
 };