From 9598059b8a7758119d56b308309245d62a6cbe98 Mon Sep 17 00:00:00 2001
From: paring <me@paring.moe>
Date: Wed, 20 Mar 2024 18:45:58 +0900
Subject: [PATCH] feat: form related components

---
 src/lib/components/form/Checkbox.svelte       | 64 +++++++++++++++++++
 src/lib/components/form/FormField.svelte      | 44 +++++++++++++
 src/lib/components/form/FormHint.svelte       | 25 ++++++++
 .../form/HorizontalFormField.svelte           | 45 +++++++++++++
 src/lib/components/form/InputControl.svelte   | 43 +++++++++++++
 .../components/form/LabeledCheckbox.svelte    | 21 ++++++
 src/lib/index.ts                              |  7 ++
 src/lib/utils/translation.ts                  |  9 ++-
 src/stories/form/Checkbox.stories.svelte      | 18 ++++++
 src/stories/form/FormField.stories.svelte     | 22 +++++++
 .../form/HorizontalFormField.stories.svelte   | 22 +++++++
 src/stories/form/InputControl.stories.svelte  | 18 ++++++
 .../form/LabeledCheckbox.stories.svelte       | 18 ++++++
 13 files changed, 354 insertions(+), 2 deletions(-)
 create mode 100644 src/lib/components/form/Checkbox.svelte
 create mode 100644 src/lib/components/form/FormField.svelte
 create mode 100644 src/lib/components/form/FormHint.svelte
 create mode 100644 src/lib/components/form/HorizontalFormField.svelte
 create mode 100644 src/lib/components/form/InputControl.svelte
 create mode 100644 src/lib/components/form/LabeledCheckbox.svelte
 create mode 100644 src/stories/form/Checkbox.stories.svelte
 create mode 100644 src/stories/form/FormField.stories.svelte
 create mode 100644 src/stories/form/HorizontalFormField.stories.svelte
 create mode 100644 src/stories/form/InputControl.stories.svelte
 create mode 100644 src/stories/form/LabeledCheckbox.stories.svelte

diff --git a/src/lib/components/form/Checkbox.svelte b/src/lib/components/form/Checkbox.svelte
new file mode 100644
index 0000000..b7545d4
--- /dev/null
+++ b/src/lib/components/form/Checkbox.svelte
@@ -0,0 +1,64 @@
+<script lang="ts">
+	/**
+	 * The checkboxes state.
+	 */
+	export let checked: boolean = false
+</script>
+
+<label class="checkbox-label">
+	<span class="checkbox-container">
+		<input
+			type="checkbox"
+			style="position: absolute; opacity: 0; pointer-events: none;"
+			bind:checked
+			{...$$restProps}
+			on:change
+		/>
+		<span class="checkbox">
+			<svg
+				class="checkbox-icon"
+				xmlns="http://www.w3.org/2000/svg"
+				width="8"
+				height="7"
+				viewBox="0 0 8 7"
+				fill="none"
+			>
+				<path d="M0.5 3L3 6L7.5 1" stroke="white" stroke-linecap="round" />
+			</svg>
+		</span>
+	</span>
+</label>
+
+<style lang="scss">
+	.checkbox-container {
+		position: relative;
+		width: 14px;
+		height: 14px;
+	}
+
+	.checkbox {
+		position: relative;
+		display: inline-block;
+		width: 14px;
+		height: 14px;
+		border: 1px solid rgba(255, 255, 255, 0.6);
+		border-radius: 3px;
+	}
+
+	.checkbox-icon {
+		position: absolute;
+		top: 50%;
+		left: 50%;
+		opacity: 0;
+		transition: opacity ease 0.1s;
+		transform: translate(-50%, -50%);
+	}
+
+	input[type='checkbox']:focus + .checkbox {
+		border-color: white;
+	}
+
+	input[type='checkbox']:checked + .checkbox > .checkbox-icon {
+		opacity: 1;
+	}
+</style>
diff --git a/src/lib/components/form/FormField.svelte b/src/lib/components/form/FormField.svelte
new file mode 100644
index 0000000..330ac7a
--- /dev/null
+++ b/src/lib/components/form/FormField.svelte
@@ -0,0 +1,44 @@
+<script lang="ts">
+	import type { TranslationKey } from '$lib/index.js'
+	import Translation from '$lib/utils/Translation.svelte'
+	import FormHint from './FormHint.svelte'
+
+	export let label: TranslationKey | null = null
+	export let error: TranslationKey | null = null
+</script>
+
+<div class="form-field">
+	<label class="form-field-content">
+		{#if label}
+			<p class="label">
+				<Translation key={label} />
+			</p>
+		{/if}
+		<slot />
+	</label>
+	{#if error}
+		<FormHint>
+			<Translation key={error} />
+		</FormHint>
+	{/if}
+</div>
+
+<style lang="scss">
+	.label {
+		font-size: 16px;
+		font-weight: 500;
+		line-height: 16px;
+	}
+
+	.form-field {
+		display: flex;
+		flex-direction: column;
+		gap: 4px;
+	}
+
+	.form-field-content {
+		display: flex;
+		flex-direction: column;
+		gap: 2px;
+	}
+</style>
diff --git a/src/lib/components/form/FormHint.svelte b/src/lib/components/form/FormHint.svelte
new file mode 100644
index 0000000..322080c
--- /dev/null
+++ b/src/lib/components/form/FormHint.svelte
@@ -0,0 +1,25 @@
+<div class="hint">
+	<slot />
+</div>
+
+<style lang="scss">
+	.hint {
+		display: flex;
+
+		color: rgba(var(--color-red), 1);
+		font-weight: 500;
+		font-size: 14px;
+		line-height: 14px;
+
+		align-items: center;
+		gap: 6px;
+
+		&::before {
+			content: '';
+			width: 8px;
+			height: 8px;
+			background-color: currentColor;
+			border-radius: 4px;
+		}
+	}
+</style>
diff --git a/src/lib/components/form/HorizontalFormField.svelte b/src/lib/components/form/HorizontalFormField.svelte
new file mode 100644
index 0000000..32b74bb
--- /dev/null
+++ b/src/lib/components/form/HorizontalFormField.svelte
@@ -0,0 +1,45 @@
+<script lang="ts">
+	import type { TranslationKey } from '$lib/index.js'
+	import Translation from '$lib/utils/Translation.svelte'
+	import FormHint from './FormHint.svelte'
+
+	export let label: TranslationKey | null = null
+	export let error: TranslationKey | null = null
+</script>
+
+<div class="form-field">
+	<label class="form-field-content">
+		{#if label}
+			<p class="label">
+				<Translation key={label} />
+			</p>
+		{/if}
+		<slot />
+	</label>
+	{#if error}
+		<FormHint>
+			<Translation key={error} />
+		</FormHint>
+	{/if}
+</div>
+
+<style lang="scss">
+	.label {
+		font-size: 16px;
+		font-weight: 500;
+		line-height: 16px;
+		flex-grow: 1;
+	}
+
+	.form-field {
+		display: flex;
+		flex-direction: column;
+		gap: 4px;
+	}
+
+	.form-field-content {
+		display: flex;
+		gap: 16px;
+		align-items: center;
+	}
+</style>
diff --git a/src/lib/components/form/InputControl.svelte b/src/lib/components/form/InputControl.svelte
new file mode 100644
index 0000000..0c508d7
--- /dev/null
+++ b/src/lib/components/form/InputControl.svelte
@@ -0,0 +1,43 @@
+<script lang="ts">
+	import { getGlobalContext, translate, type TranslationKey } from '$lib/index.js'
+
+	export let placeholder: TranslationKey | null = null
+
+	const ctx = getGlobalContext()
+
+	$: translatedPlaceholder = placeholder ? translate(ctx.language, placeholder, {}, false) : null
+
+	$: console.log($translatedPlaceholder)
+</script>
+
+<div class="input-control">
+	<input
+		{...$$restProps}
+		placeholder={translatedPlaceholder ? $translatedPlaceholder : null}
+		class="input"
+	/>
+</div>
+
+<style lang="scss">
+	.input-control {
+		height: 32px;
+
+		display: flex;
+
+		border-bottom: 1px solid rgba(255, 255, 255, 0.4);
+	}
+
+	.input {
+		flex-grow: 1;
+		background: transparent;
+		&:focus {
+			outline: none;
+		}
+
+		&::placeholder {
+			font-weight: 300;
+			font-size: 16px;
+			line-height: 16px;
+		}
+	}
+</style>
diff --git a/src/lib/components/form/LabeledCheckbox.svelte b/src/lib/components/form/LabeledCheckbox.svelte
new file mode 100644
index 0000000..043786d
--- /dev/null
+++ b/src/lib/components/form/LabeledCheckbox.svelte
@@ -0,0 +1,21 @@
+<script lang="ts">
+	import { Checkbox, type TranslationKey } from '$lib/index.js'
+
+	export let label: TranslationKey
+</script>
+
+<!-- svelte-ignore a11y-label-has-associated-control -->
+<label class="label">
+	<Checkbox />
+	<span>{label}</span>
+</label>
+
+<style lang="scss">
+	.label {
+		display: flex;
+		gap: 8px;
+		align-items: center;
+		font-size: 14px;
+		line-height: 14px;
+	}
+</style>
diff --git a/src/lib/index.ts b/src/lib/index.ts
index 644ee21..87856dc 100644
--- a/src/lib/index.ts
+++ b/src/lib/index.ts
@@ -40,3 +40,10 @@ export { default as NavAccessibilitySettings } from './components/nav/NavAccessi
 export { default as Footer } from './components/footer/Footer.svelte'
 export { default as FooterLink } from './components/footer/FooterLink.svelte'
 export { default as FooterSection } from './components/footer/FooterSection.svelte'
+
+// Form
+export { default as FormField } from './components/form/FormField.svelte'
+export { default as HorizontalFormField } from './components/form/HorizontalFormField.svelte'
+export { default as InputControl } from './components/form/InputControl.svelte'
+export { default as Checkbox } from './components/form/Checkbox.svelte'
+export { default as LabeledCheckbox } from './components/form/LabeledCheckbox.svelte'
diff --git a/src/lib/utils/translation.ts b/src/lib/utils/translation.ts
index bbffbb8..3db6b82 100644
--- a/src/lib/utils/translation.ts
+++ b/src/lib/utils/translation.ts
@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/ban-types */
+
 import { writable, type Readable, derived } from 'svelte/store'
 
 import langs from '../localization/langs.json'
@@ -17,8 +19,11 @@ const langSections = ['common', 'footer', 'nav'] as const
 
 export type LangSection = (typeof langSections)[number] | ADOFAIGG_UI.ExtraLangSections[number]
 export type LangData = Record<string, FluentBundle>
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type StringTranslationKey = `${LangSection}:` | (`${LangSection}:${string & {}}` & {})
+export type StringTranslationKey =
+	| `${LangSection}:`
+	| (`${LangSection}:${string & {}}` & {})
+	| (`${string}:${string}` & {})
+
 export type ArrayTranslationKey = [LangSection, string]
 export type TranslationKey = StringTranslationKey | ArrayTranslationKey
 
diff --git a/src/stories/form/Checkbox.stories.svelte b/src/stories/form/Checkbox.stories.svelte
new file mode 100644
index 0000000..19f9337
--- /dev/null
+++ b/src/stories/form/Checkbox.stories.svelte
@@ -0,0 +1,18 @@
+<script lang="ts" context="module">
+	import { Checkbox } from '$lib/index.js'
+	import { Story, Template } from '@storybook/addon-svelte-csf'
+	import type { Meta } from '@storybook/svelte'
+
+	export const meta: Meta = {
+		component: Checkbox,
+		title: 'Components/Form/Controls/Checkbox'
+	}
+</script>
+
+<Template let:args>
+	<Checkbox {...args} />
+</Template>
+
+<Story name="Default" args={{}} />
+
+<Story name="Checked" args={{ checked: true }} />
diff --git a/src/stories/form/FormField.stories.svelte b/src/stories/form/FormField.stories.svelte
new file mode 100644
index 0000000..13d06b8
--- /dev/null
+++ b/src/stories/form/FormField.stories.svelte
@@ -0,0 +1,22 @@
+<script lang="ts" context="module">
+	import { FormField, InputControl } from '$lib/index.js'
+	import { Story, Template } from '@storybook/addon-svelte-csf'
+	import type { Meta } from '@storybook/svelte'
+
+	export const meta: Meta = {
+		component: FormField,
+		title: 'Components/Form/Form Field'
+	}
+</script>
+
+<Template let:args>
+	<FormField {...args}>
+		<InputControl placeholder="custom:Wow sans" />
+	</FormField>
+</Template>
+
+<Story name="Default" args={{}} />
+
+<Story name="Labeled" args={{ label: 'custom:Label' }} />
+
+<Story name="With Error" args={{ label: 'custom:Label', error: 'custom:Wow this is error' }} />
diff --git a/src/stories/form/HorizontalFormField.stories.svelte b/src/stories/form/HorizontalFormField.stories.svelte
new file mode 100644
index 0000000..90acfdd
--- /dev/null
+++ b/src/stories/form/HorizontalFormField.stories.svelte
@@ -0,0 +1,22 @@
+<script lang="ts" context="module">
+	import { HorizontalFormField, InputControl } from '$lib/index.js'
+	import { Story, Template } from '@storybook/addon-svelte-csf'
+	import type { Meta } from '@storybook/svelte'
+
+	export const meta: Meta = {
+		component: HorizontalFormField,
+		title: 'Components/Form/Horizontal Form Field'
+	}
+</script>
+
+<Template let:args>
+	<HorizontalFormField {...args}>
+		<InputControl placeholder="custom:Wow sans" />
+	</HorizontalFormField>
+</Template>
+
+<Story name="Default" args={{}} />
+
+<Story name="Labeled" args={{ label: 'custom:Label' }} />
+
+<Story name="With Error" args={{ label: 'custom:Label', error: 'custom:Wow this is error' }} />
diff --git a/src/stories/form/InputControl.stories.svelte b/src/stories/form/InputControl.stories.svelte
new file mode 100644
index 0000000..0f9a582
--- /dev/null
+++ b/src/stories/form/InputControl.stories.svelte
@@ -0,0 +1,18 @@
+<script lang="ts" context="module">
+	import { InputControl } from '$lib/index.js'
+	import { Story, Template } from '@storybook/addon-svelte-csf'
+	import type { Meta } from '@storybook/svelte'
+
+	export const meta: Meta = {
+		component: InputControl,
+		title: 'Components/Form/Controls/Input Control'
+	}
+</script>
+
+<Template let:args>
+	<InputControl {...args} />
+</Template>
+
+<Story name="Default" args={{}} />
+
+<Story name="With Placeholder" args={{ placeholder: 'custom:Wow Placeholder' }} />
diff --git a/src/stories/form/LabeledCheckbox.stories.svelte b/src/stories/form/LabeledCheckbox.stories.svelte
new file mode 100644
index 0000000..2e5522a
--- /dev/null
+++ b/src/stories/form/LabeledCheckbox.stories.svelte
@@ -0,0 +1,18 @@
+<script lang="ts" context="module">
+	import { LabeledCheckbox } from '$lib/index.js'
+	import { Story, Template } from '@storybook/addon-svelte-csf'
+	import type { Meta } from '@storybook/svelte'
+
+	export const meta: Meta = {
+		component: LabeledCheckbox,
+		title: 'Components/Form/Controls/Labeled Checkbox'
+	}
+</script>
+
+<Template let:args>
+	<LabeledCheckbox label="custom:wow this is label" {...args} />
+</Template>
+
+<Story name="Default" args={{}} />
+
+<Story name="Checked" args={{ checked: true }} />