From 830286c332cd9b0270b5ed6a581e8a2107ccb7b5 Mon Sep 17 00:00:00 2001
From: Chaim Lev-Ari <chiptus@users.noreply.github.com>
Date: Tue, 23 Nov 2021 07:16:50 +0200
Subject: [PATCH] feat(app): introduce input-group component [EE-2062] (#6135)

---
 app/assets/css/app.css                        |   4 +
 .../form-components/Input/NumberInput.tsx     |   2 +
 .../form-components/Input/Select.tsx          |   2 +
 .../form-components/Input/TextInput.tsx       |   2 +
 .../form-components/Input/Textarea.tsx        |   6 +
 .../components/form-components/Input/types.ts |   1 +
 .../InputGroup/InputGroup.stories.tsx         | 108 ++++++++++++++++++
 .../form-components/InputGroup/InputGroup.tsx |  37 ++++++
 .../InputGroup/InputGroupAddon.tsx            |   9 ++
 .../InputGroup/InputGroupButtonWrapper.tsx    |  11 ++
 .../form-components/InputGroup/index.ts       |  23 ++++
 11 files changed, 205 insertions(+)
 create mode 100644 app/portainer/components/form-components/InputGroup/InputGroup.stories.tsx
 create mode 100644 app/portainer/components/form-components/InputGroup/InputGroup.tsx
 create mode 100644 app/portainer/components/form-components/InputGroup/InputGroupAddon.tsx
 create mode 100644 app/portainer/components/form-components/InputGroup/InputGroupButtonWrapper.tsx
 create mode 100644 app/portainer/components/form-components/InputGroup/index.ts

diff --git a/app/assets/css/app.css b/app/assets/css/app.css
index 700e887df..91b058fe2 100644
--- a/app/assets/css/app.css
+++ b/app/assets/css/app.css
@@ -836,6 +836,10 @@ json-tree .branch-preview {
   align-items: center;
 }
 
+.space-y-8 > * + * {
+  margin-top: 2rem;
+}
+
 .my-8 {
   margin-top: 2rem;
   margin-bottom: 2rem;
diff --git a/app/portainer/components/form-components/Input/NumberInput.tsx b/app/portainer/components/form-components/Input/NumberInput.tsx
index a05d909cf..5a583b51c 100644
--- a/app/portainer/components/form-components/Input/NumberInput.tsx
+++ b/app/portainer/components/form-components/Input/NumberInput.tsx
@@ -16,6 +16,7 @@ export function NumberInput({
   value,
   className,
   readonly,
+  placeholder,
   onChange,
 }: Props) {
   return (
@@ -27,6 +28,7 @@ export function NumberInput({
       disabled={disabled}
       readonly={readonly}
       required={required}
+      placeholder={placeholder}
       onChange={(value) => onChange(parseFloat(value))}
     />
   );
diff --git a/app/portainer/components/form-components/Input/Select.tsx b/app/portainer/components/form-components/Input/Select.tsx
index d6776bd79..ea00f7d32 100644
--- a/app/portainer/components/form-components/Input/Select.tsx
+++ b/app/portainer/components/form-components/Input/Select.tsx
@@ -20,6 +20,7 @@ export function Select<T extends number | string>({
   disabled,
   id,
   required,
+  placeholder,
 }: Props<T>) {
   return (
     <select
@@ -28,6 +29,7 @@ export function Select<T extends number | string>({
       id={id}
       required={required}
       className={clsx(className, 'form-control')}
+      placeholder={placeholder}
       onChange={handleChange}
     >
       {options.map((item) => (
diff --git a/app/portainer/components/form-components/Input/TextInput.tsx b/app/portainer/components/form-components/Input/TextInput.tsx
index 69e0301e0..14d9bfefc 100644
--- a/app/portainer/components/form-components/Input/TextInput.tsx
+++ b/app/portainer/components/form-components/Input/TextInput.tsx
@@ -17,6 +17,7 @@ export function TextInput({
   disabled,
   readonly,
   required,
+  placeholder,
 }: TextInputProps) {
   return (
     <BaseInput
@@ -28,6 +29,7 @@ export function TextInput({
       disabled={disabled}
       readonly={readonly}
       required={required}
+      placeholder={placeholder}
     />
   );
 }
diff --git a/app/portainer/components/form-components/Input/Textarea.tsx b/app/portainer/components/form-components/Input/Textarea.tsx
index 4db29d778..29d094c90 100644
--- a/app/portainer/components/form-components/Input/Textarea.tsx
+++ b/app/portainer/components/form-components/Input/Textarea.tsx
@@ -11,6 +11,9 @@ export function Textarea({
   onChange,
   value,
   id,
+  placeholder,
+  disabled,
+  required,
 }: Props & InputProps) {
   return (
     <BaseInput
@@ -20,6 +23,9 @@ export function Textarea({
       className={className}
       value={value}
       onChange={onChange}
+      placeholder={placeholder}
+      disabled={disabled}
+      required={required}
     />
   );
 }
diff --git a/app/portainer/components/form-components/Input/types.ts b/app/portainer/components/form-components/Input/types.ts
index 5388a7cb1..ab56be7a2 100644
--- a/app/portainer/components/form-components/Input/types.ts
+++ b/app/portainer/components/form-components/Input/types.ts
@@ -3,6 +3,7 @@ export interface InputProps {
   className?: string;
   required?: boolean;
   disabled?: boolean;
+  placeholder?: string;
 }
 
 export interface ChangeProps<T> {
diff --git a/app/portainer/components/form-components/InputGroup/InputGroup.stories.tsx b/app/portainer/components/form-components/InputGroup/InputGroup.stories.tsx
new file mode 100644
index 000000000..fe278e965
--- /dev/null
+++ b/app/portainer/components/form-components/InputGroup/InputGroup.stories.tsx
@@ -0,0 +1,108 @@
+import { Meta } from '@storybook/react';
+import { useState } from 'react';
+
+import { InputGroup } from '.';
+
+export default {
+  component: InputGroup,
+  title: 'Components/Form/InputGroup',
+} as Meta;
+
+export function BasicExample() {
+  const [value1, setValue1] = useState('');
+  const [valueNumber, setValueNumber] = useState(0);
+
+  return (
+    <div className="space-y-8">
+      <InputGroup>
+        <InputGroup.Addon>@</InputGroup.Addon>
+        <InputGroup.Input
+          value={value1}
+          onChange={setValue1}
+          placeholder="Username"
+          aria-describedby="basic-addon1"
+        />
+      </InputGroup>
+
+      <InputGroup>
+        <InputGroup.Input
+          value={value1}
+          onChange={setValue1}
+          placeholder="Recipient's username"
+          aria-describedby="basic-addon2"
+        />
+        <InputGroup.Addon>@example.com</InputGroup.Addon>
+      </InputGroup>
+
+      <InputGroup>
+        <InputGroup.Addon>$</InputGroup.Addon>
+        <InputGroup.NumberInput
+          value={valueNumber}
+          onChange={setValueNumber}
+          aria-label="Amount (to the nearest dollar)"
+        />
+        <InputGroup.Addon>.00</InputGroup.Addon>
+      </InputGroup>
+
+      <label htmlFor="basic-url">Your vanity URL</label>
+      <InputGroup>
+        <InputGroup.Addon>https://example.com/users/</InputGroup.Addon>
+        <InputGroup.Input
+          value={value1}
+          onChange={setValue1}
+          id="basic-url"
+          aria-describedby="basic-addon3"
+        />
+      </InputGroup>
+    </div>
+  );
+}
+
+export function Addons() {
+  const [value1, setValue1] = useState('');
+  const [value2, setValue2] = useState('');
+  return (
+    <div className="row">
+      <div className="col-lg-6">
+        <InputGroup>
+          <InputGroup.ButtonWrapper>
+            <button className="btn btn-default" type="button">
+              Go!
+            </button>
+          </InputGroup.ButtonWrapper>
+          <InputGroup.Input value={value1} onChange={setValue1} />
+        </InputGroup>
+      </div>
+      <div className="col-lg-6">
+        <InputGroup>
+          <InputGroup.Input value={value2} onChange={setValue2} />
+          <InputGroup.Addon>
+            <input type="checkbox" />
+          </InputGroup.Addon>
+        </InputGroup>
+      </div>
+    </div>
+  );
+}
+
+export function Sizing() {
+  const [value, setValue] = useState('');
+  return (
+    <div className="space-y-8">
+      <InputGroup size="small">
+        <InputGroup.Addon>Small</InputGroup.Addon>
+        <InputGroup.Input value={value} onChange={setValue} />
+      </InputGroup>
+
+      <InputGroup>
+        <InputGroup.Addon>Default</InputGroup.Addon>
+        <InputGroup.Input value={value} onChange={setValue} />
+      </InputGroup>
+
+      <InputGroup size="large">
+        <InputGroup.Addon>Large</InputGroup.Addon>
+        <InputGroup.Input value={value} onChange={setValue} />
+      </InputGroup>
+    </div>
+  );
+}
diff --git a/app/portainer/components/form-components/InputGroup/InputGroup.tsx b/app/portainer/components/form-components/InputGroup/InputGroup.tsx
new file mode 100644
index 000000000..a3111b578
--- /dev/null
+++ b/app/portainer/components/form-components/InputGroup/InputGroup.tsx
@@ -0,0 +1,37 @@
+import clsx from 'clsx';
+import { createContext, PropsWithChildren, useContext } from 'react';
+
+const Context = createContext<null | boolean>(null);
+
+type Size = 'small' | 'large';
+
+export function useInputGroupContext() {
+  const context = useContext(Context);
+
+  if (context == null) {
+    throw new Error('Should be inside a InputGroup component');
+  }
+}
+
+interface Props {
+  size?: Size;
+}
+
+export function InputGroup({ children, size }: PropsWithChildren<Props>) {
+  return (
+    <Context.Provider value>
+      <div className={clsx('input-group', sizeClass(size))}>{children}</div>
+    </Context.Provider>
+  );
+}
+
+function sizeClass(size?: Size) {
+  switch (size) {
+    case 'large':
+      return 'input-group-lg';
+    case 'small':
+      return 'input-group-sm';
+    default:
+      return '';
+  }
+}
diff --git a/app/portainer/components/form-components/InputGroup/InputGroupAddon.tsx b/app/portainer/components/form-components/InputGroup/InputGroupAddon.tsx
new file mode 100644
index 000000000..32d294367
--- /dev/null
+++ b/app/portainer/components/form-components/InputGroup/InputGroupAddon.tsx
@@ -0,0 +1,9 @@
+import { PropsWithChildren } from 'react';
+
+import { useInputGroupContext } from './InputGroup';
+
+export function InputGroupAddon({ children }: PropsWithChildren<unknown>) {
+  useInputGroupContext();
+
+  return <span className="input-group-addon">{children}</span>;
+}
diff --git a/app/portainer/components/form-components/InputGroup/InputGroupButtonWrapper.tsx b/app/portainer/components/form-components/InputGroup/InputGroupButtonWrapper.tsx
new file mode 100644
index 000000000..a09ab254c
--- /dev/null
+++ b/app/portainer/components/form-components/InputGroup/InputGroupButtonWrapper.tsx
@@ -0,0 +1,11 @@
+import { PropsWithChildren } from 'react';
+
+import { useInputGroupContext } from './InputGroup';
+
+export function InputGroupButtonWrapper({
+  children,
+}: PropsWithChildren<unknown>) {
+  useInputGroupContext();
+
+  return <span className="input-group-btn">{children}</span>;
+}
diff --git a/app/portainer/components/form-components/InputGroup/index.ts b/app/portainer/components/form-components/InputGroup/index.ts
new file mode 100644
index 000000000..f9c5cb7d4
--- /dev/null
+++ b/app/portainer/components/form-components/InputGroup/index.ts
@@ -0,0 +1,23 @@
+import { NumberInput, TextInput } from '../Input';
+
+import { InputGroup as MainComponent } from './InputGroup';
+import { InputGroupAddon } from './InputGroupAddon';
+import { InputGroupButtonWrapper } from './InputGroupButtonWrapper';
+
+interface InputGroupSubComponents {
+  Addon: typeof InputGroupAddon;
+  ButtonWrapper: typeof InputGroupButtonWrapper;
+  Input: typeof TextInput;
+  NumberInput: typeof NumberInput;
+}
+
+const InputGroup: typeof MainComponent &
+  InputGroupSubComponents = MainComponent as typeof MainComponent &
+  InputGroupSubComponents;
+
+InputGroup.Addon = InputGroupAddon;
+InputGroup.ButtonWrapper = InputGroupButtonWrapper;
+InputGroup.Input = TextInput;
+InputGroup.NumberInput = NumberInput;
+
+export { InputGroup };