@public-ui/sample-react 3.0.8-rc.1 → 3.0.8-rc.2

package/src/components/input-number/number-formatter.tsx

@@ -1,8 +1,17 @@
-import { KolForm, KolInputNumber } from '@public-ui/react-v19';
-import * as React from 'react';
+import { KolForm, KolInputNumber, KolInputText } from '@public-ui/react-v19';
+import React, { type BaseSyntheticEvent } from 'react';
+import { Controller, useForm } from 'react-hook-form';
+import { NumericFormat, type NumberFormatValues, type NumericFormatProps } from 'react-number-format';
 
 import { SampleDescription } from '../SampleDescription';
 
+type KolInputTextEvents = {
+	onBlur?: (event: Event) => void;
+	onChange?: (event: Event, value: unknown) => void;
+	onFocus?: (event: Event) => void;
+	onInput?: (event: Event, value: unknown) => void;
+};
+
 class NumberFormatter {
 	public parse(value: unknown): string {
 		if (value === undefined || value === null || value === '') {
@@ -22,22 +31,147 @@ const preventInvalidKeyDown = (event: KeyboardEvent) => {
 	}
 };
 
+type KolNumericFormatControllerProps = {
+	_label: string;
+	_msg?: React.ComponentProps<typeof KolInputText>['_msg'];
+	_touched?: boolean;
+	_on?: React.ComponentProps<typeof KolInputText>['_on'];
+	_required?: boolean;
+	value?: number;
+} & Omit<NumericFormatProps, 'customInput' | 'value' | 'onBlur' | 'onValueChange'>;
+
+function KolNumericFormat({
+	_label,
+	_msg,
+	_touched,
+	_on,
+	_required,
+	value,
+	thousandSeparator = true,
+	suffix = '€',
+	...props
+}: KolNumericFormatControllerProps) {
+	const normalizedOn = _on && typeof _on === 'object' ? (_on as KolInputTextEvents) : undefined;
+
+	return (
+		<NumericFormat
+			{...(props as any)}
+			value={value}
+			suffix={suffix}
+			thousandSeparator={thousandSeparator}
+			valueIsNumericString={false}
+			customInput={(inputProps: any) => {
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+				const inputValue = inputProps.value;
+				return (
+					<KolInputText
+						{...inputProps}
+						_value={inputValue}
+						_label={_label}
+						_msg={_msg}
+						_touched={_touched}
+						_required={_required}
+						_on={{
+							// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+							onBlur: inputProps.onBlur as ((event: Event) => void) | undefined,
+							// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+							onChange: inputProps.onChange as ((event: Event, value: unknown) => void) | undefined,
+							// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+							onFocus: inputProps.onFocus as ((event: Event) => void) | undefined,
+							// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+							onInput: inputProps.onInput as ((event: Event, value: unknown) => void) | undefined,
+						}}
+					/>
+				);
+			}}
+			onValueChange={(numericValue: NumberFormatValues) => {
+				const fakeEvent = new Event('input');
+				normalizedOn?.onInput?.(fakeEvent, numericValue.floatValue);
+			}}
+			onBlur={(event) => {
+				normalizedOn?.onBlur?.(event.nativeEvent);
+			}}
+		/>
+	);
+}
+
+function KolNumericFormatController(props: any) {
+	const { name, control, rules, defaultValue, shouldUnregister, disabled, _label, _required, ...componentProps } = props;
+	return (
+		<Controller
+			name={name}
+			control={control}
+			rules={rules}
+			defaultValue={defaultValue}
+			shouldUnregister={shouldUnregister}
+			disabled={disabled}
+			render={({ field, fieldState }) => {
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+				const userHandlers = componentProps._on as KolInputTextEvents | undefined;
+				return (
+					<KolNumericFormat
+						{...(componentProps as any)}
+						_label={_label}
+						_required={_required}
+						value={field.value}
+						_touched={fieldState.isTouched}
+						_msg={
+							fieldState.error
+								? {
+										_type: 'error' as const,
+										_description: fieldState.error.message || String(fieldState.error),
+									}
+								: undefined
+						}
+						_on={{
+							onInput: (event: Event, value: unknown) => {
+								field.onChange(value);
+								userHandlers?.onInput?.(event, value);
+							},
+							onBlur: () => field.onBlur(),
+						}}
+					/>
+				);
+			}}
+		/>
+	);
+}
+
+type CurrencyExampleFormValues = {
+	currency: number;
+};
+
 export function InputNumberNumberFormatter() {
 	const formatter = new NumberFormatter();
 	const [displayValue, setDisplayValue] = React.useState<number | undefined>(undefined);
 	const [value, setValue] = React.useState<number | undefined>(-128);
 	const [touched, setTouched] = React.useState(false);
 
+	const initialCurrencyExampleValues: CurrencyExampleFormValues = {
+		currency: 1000000,
+	};
+
+	const currencyForm = useForm<CurrencyExampleFormValues>({
+		defaultValues: initialCurrencyExampleValues,
+		mode: 'onTouched',
+	});
+
+	const currencyValues = currencyForm.watch();
+
+	const handleCurrencySubmit = (event: Event) => {
+		void currencyForm.handleSubmit(async () => {})(event as unknown as BaseSyntheticEvent);
+	};
+
 	return (
 		<>
 			<SampleDescription>
 				<p>
-					This example demonstrates formatting number input to whole numbers. Decimal separators (. and ,) and scientific notation (e) are automatically removed
-					on input.
+					This example demonstrates formatting number input. The first example shows whole number formatting where decimal separators (. and ,) and scientific
+					notation (e) are automatically removed on input. The second example shows currency formatting with react-number-format in a react-hook-form context.
 				</p>
 			</SampleDescription>
-			<section className="w-full">
-				<div className="p-2">
+			<section className="w-full grid gap-4">
+				<div>
 					<KolForm>
 						<KolInputNumber
 							_label="Whole number"
@@ -58,7 +192,22 @@ export function InputNumberNumberFormatter() {
 							}}
 						/>
 					</KolForm>
-					<pre className="text-base">{JSON.stringify({ value, touched }, null, 2)}</pre>
+					<pre className="text-base mt-2">{JSON.stringify({ value, touched }, null, 2)}</pre>
+				</div>
+
+				<div>
+					<KolForm _on={{ onSubmit: handleCurrencySubmit }}>
+						<KolNumericFormatController
+							control={currencyForm.control as any}
+							name="currency"
+							decimalScale={2}
+							displayType="input"
+							rules={{ required: 'Please enter a currency amount.' }}
+							_label="Currency"
+							_required
+						/>
+					</KolForm>
+					<pre className="text-base mt-2">{JSON.stringify(currencyValues, null, 2)}</pre>
 				</div>
 			</section>
 		</>

package/src/components/input-text/text-formatter.tsx

@@ -1,9 +1,24 @@
-import { KolForm, KolHeading, KolInputText } from '@public-ui/react-v19';
-import { Field, Formik, type FieldProps } from 'formik';
-import * as React from 'react';
+import { KolForm, KolInputText } from '@public-ui/react-v19';
+import React, { useMemo, useRef, type BaseSyntheticEvent } from 'react';
+import { Controller, useForm } from 'react-hook-form';
+
 import { SampleDescription } from '../SampleDescription';
 
-import { NumericFormat, type NumberFormatValues } from 'react-number-format';
+type InputTextElementSelection = {
+	setSelectionStart?: (position: number) => Promise<void>;
+	selectionStart?: () => Promise<number | null>;
+};
+
+type KolInputTextEvents = {
+	onBlur?: (event: Event) => void;
+	onChange?: (event: Event, value: unknown) => void;
+	onFocus?: (event: Event) => void;
+	onInput?: (event: Event, value: unknown) => void;
+};
+type KolInputTextProps = Omit<React.ComponentProps<typeof KolInputText>, '_on' | '_value'> & {
+	_on?: KolInputTextEvents;
+	_value?: string;
+};
 
 const NON_ALPHANUM = /[^a-zA-Z0-9]/g;
 const EVERY_FOUR_CHARS = /(.{4})(?!$)/g;
@@ -20,10 +35,12 @@ class IbanFormatter {
 	public parse(value: string): string {
 		return this.electronicFormat(value);
 	}
+
 	public format(value: string, ref?: HTMLKolInputTextElement | null, selectionStart?: number | null): string {
-		if (ref && selectionStart) {
+		const setSelectionStart = (ref as InputTextElementSelection | null)?.setSelectionStart;
+		if (selectionStart && setSelectionStart) {
 			if (selectionStart % 5 === 0) selectionStart++;
-			ref?.setSelectionStart(selectionStart);
+			void setSelectionStart(selectionStart);
 		}
 		return this.printFormat(value);
 	}
@@ -33,23 +50,104 @@ type IbanExampleFormValues = {
 	iban: string;
 };
 
-type CurrencyExampleFormValues = {
-	currency: number;
-};
+function FormattedKolInputText({
+	formatter,
+	selectionStartRef,
+	_on,
+	_value,
+	...props
+}: KolInputTextProps & {
+	formatter: IbanFormatter;
+	selectionStartRef: React.MutableRefObject<number | null>;
+}) {
+	const inputRef = useRef<HTMLKolInputTextElement | null>(null);
+	const normalizedOn = _on && typeof _on === 'object' ? (_on as KolInputTextEvents) : undefined;
+	const sanitizedSelectionRef = selectionStartRef as React.MutableRefObject<number | null>;
+
+	const element = inputRef.current;
+	const selectionStart = sanitizedSelectionRef.current;
+	const sanitizedFormatter: IbanFormatter = formatter;
+
+	return (
+		<KolInputText
+			{...props}
+			ref={inputRef}
+			_value={sanitizedFormatter.format(_value ?? '', element, selectionStart)}
+			_on={{
+				...normalizedOn,
+				onInput: (event: Event, value: unknown) => {
+					const selectionStartGetter = (inputRef.current as InputTextElementSelection | null)?.selectionStart;
+					selectionStartGetter?.().then((start) => {
+						sanitizedSelectionRef.current = start ?? null;
+					});
+					const parsedValue = sanitizedFormatter.parse(typeof value === 'string' ? value : '');
+					normalizedOn?.onInput?.(event, parsedValue);
+				},
+			}}
+		/>
+	);
+}
+
+function KolFormattedIbanController(props: any) {
+	const { name, control, rules, defaultValue, shouldUnregister, disabled, formatter, selectionStartRef, ...componentProps } = props;
+	return (
+		<Controller
+			name={name}
+			control={control}
+			rules={rules}
+			defaultValue={defaultValue}
+			shouldUnregister={shouldUnregister}
+			disabled={disabled}
+			render={({ field, fieldState }) => {
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+				const userHandlers = componentProps._on as KolInputTextEvents | undefined;
+				return (
+					<FormattedKolInputText
+						{...(componentProps as any)}
+						formatter={formatter}
+						selectionStartRef={selectionStartRef}
+						_value={field.value}
+						_touched={fieldState.isTouched}
+						_msg={
+							fieldState.error
+								? {
+										_type: 'error' as const,
+										_description: fieldState.error.message || String(fieldState.error),
+									}
+								: undefined
+						}
+						_on={{
+							onInput: (event: Event, value: unknown) => {
+								field.onChange(value);
+								userHandlers?.onInput?.(event, value);
+							},
+							onBlur: () => field.onBlur(),
+						}}
+					/>
+				);
+			}}
+		/>
+	);
+}
 
 export function InputTextFormatterDemo() {
-	const handleSubmit = async () => {};
-	const formatter = new IbanFormatter();
+	const formatter = useMemo(() => new IbanFormatter(), []);
 
-	const textInput1 = React.useRef<HTMLKolInputTextElement>(null);
-	let textInput1SelectionStart: number | null | undefined;
+	const textInput1SelectionStart = useRef<number | null>(null);
 
 	const initialIbanExampleValues: IbanExampleFormValues = {
 		iban: 'DE89370400440532013000',
 	};
 
-	const initialCurrencyExampleValues: CurrencyExampleFormValues = {
-		currency: 1000000,
+	const ibanForm = useForm<IbanExampleFormValues>({
+		defaultValues: initialIbanExampleValues,
+		mode: 'onTouched',
+	});
+
+	const ibanValues = ibanForm.watch();
+
+	const handleIbanSubmit = (event: Event) => {
+		void ibanForm.handleSubmit(async () => {})(event as unknown as BaseSyntheticEvent);
 	};
 
 	return (
@@ -60,93 +158,22 @@ export function InputTextFormatterDemo() {
 					vice versa the formatting is removed again (machine format)
 				</p>
 			</SampleDescription>
-			<section className="w-full flex flex-col">
-				<Formik<IbanExampleFormValues> initialValues={initialIbanExampleValues} onSubmit={handleSubmit}>
-					{(form) => (
-						<>
-							<div className="p-2">
-								<KolHeading _label="Formatted Form Field" _level={2} />
-								<KolForm>
-									<Field name="iban">
-										{({ field }: FieldProps<IbanExampleFormValues['iban']>) => (
-											<div className="block mt-2">
-												<KolInputText
-													ref={textInput1}
-													onBlur={() => {
-														void form.setFieldTouched('iban', true);
-													}}
-													id="field-iban"
-													_label="IBAN"
-													_value={formatter.format(field.value ?? '', textInput1.current, textInput1SelectionStart)}
-													_msg={{
-														_type: 'error',
-														_description: form.errors.iban || '',
-													}}
-													_touched={form.touched.iban}
-													_required
-													_on={{
-														onInput: (event, value: unknown) => {
-															if (event.target) {
-																textInput1.current?.selectionStart().then((start) => {
-																	textInput1SelectionStart = start;
-																});
-																const parsed_value = formatter.parse((value as string) ?? '');
-																void form.setFieldValue('iban', parsed_value, true);
-															}
-														},
-													}}
-												/>
-											</div>
-										)}
-									</Field>
-								</KolForm>
-							</div>
-							<div className="p-2">
-								<KolHeading _label="Model" _level={2} />
-								<pre className="text-base">{JSON.stringify(form.values, null, 2)}</pre>
-							</div>
-						</>
-					)}
-				</Formik>
-			</section>
-
-			<section className="w-full flex flex-col">
-				<Formik<CurrencyExampleFormValues> initialValues={initialCurrencyExampleValues} onSubmit={handleSubmit}>
-					{(form) => (
-						<>
-							<div className="p-2">
-								<KolHeading _label="Formatted Form Field (with react-number-format)" _level={2} />
-								<KolForm>
-									<Field name="currency">
-										{({ field }: FieldProps<CurrencyExampleFormValues['currency']>) => (
-											<div className="block mt-2">
-												<NumericFormat
-													customInput={({ type, value, onBlur, onChange, onFocus }: any) => {
-														return <KolInputText _label="Currency" _type={type} _value={value} _on={{ onBlur, onChange, onFocus }} />;
-													}}
-													displayType="input"
-													value={typeof field.value === 'number' ? field.value.toFixed(2) : undefined}
-													onBlur={() => {
-														void form.setFieldTouched('currency', true);
-													}}
-													onValueChange={(value: NumberFormatValues) => {
-														void form.setFieldValue('currency', value.floatValue, true);
-													}}
-													suffix={'€'}
-													thousandSeparator={true}
-												/>
-											</div>
-										)}
-									</Field>
-								</KolForm>
-							</div>
-							<div className="p-2">
-								<KolHeading _label="Model" _level={2} />
-								<pre className="text-base">{JSON.stringify(form.values, null, 2)}</pre>
-							</div>
-						</>
-					)}
-				</Formik>
+			<section className="w-full">
+				<div>
+					<KolForm _on={{ onSubmit: handleIbanSubmit }}>
+						<KolFormattedIbanController
+							control={ibanForm.control as any}
+							name="iban"
+							id="field-iban"
+							formatter={formatter}
+							selectionStartRef={textInput1SelectionStart}
+							rules={{ required: 'Please enter an IBAN.' }}
+							_label="IBAN"
+							_required
+						/>
+					</KolForm>
+					<pre className="text-base mt-2">{JSON.stringify(ibanValues, null, 2)}</pre>
+				</div>
 			</section>
 		</>
 	);

package/src/components/table/predefined-settings.tsx

@@ -27,9 +27,9 @@ export const PredefinedSettings: FC = () => {
 				}}
 				_tableSettings={{
 					columns: [
-						{ key: 'columnA', visible: false, label: 'Column A', position: 2 },
-						{ key: 'columnB', visible: true, label: 'Column B', position: 1, width: 20 },
-						{ key: 'columnC', visible: true, label: 'Column C', position: 0, width: 45 },
+						{ key: 'columnC', visible: true, label: 'Column C', width: 45 },
+						{ key: 'columnB', visible: true, label: 'Column B', width: 20 },
+						{ key: 'columnA', visible: false, label: 'Column A' },
 					],
 				}}
 				_data={DATA}

package/src/components/table/routes.ts

@@ -9,6 +9,7 @@ import { TableNonHidableColumns } from './non-hidable-columns';
 import { PaginationPosition } from './pagination-position';
 import { PredefinedSettings } from './predefined-settings';
 import { TableRenderCell } from './render-cell';
+import { TableSettingsColumnOptions } from './settings-column-options';
 import { TableSortData } from './sort-data';
 import { TableStatefulWithSelection } from './stateful-with-selection';
 import { TableStatefulWithSingleSelection } from './stateful-with-single-selection';
@@ -31,6 +32,7 @@ export const TABLE_ROUTES: Routes = {
 		'pagination-position': PaginationPosition,
 		'predefined-settings': PredefinedSettings,
 		'render-cell': TableRenderCell,
+		'settings-column-options': TableSettingsColumnOptions,
 		'sort-data': TableSortData,
 		'direction-aware-sort': TableDirectionAwareSort,
 		'stateful-with-selection': TableStatefulWithSelection,

package/src/components/table/settings-column-options.tsx

@@ -0,0 +1,58 @@
+import { KolTableStateful } from '@public-ui/react-v19';
+import type { FC } from 'react';
+import React from 'react';
+import { SampleDescription } from '../SampleDescription';
+
+type UserRow = {
+	id: string;
+	name: string;
+	team: string;
+	email: string;
+	status: string;
+};
+
+const DATA: UserRow[] = [
+	{ id: 'U-001', name: 'Andrea Schmidt', team: 'Design', email: 'andrea@example.org', status: 'Active' },
+	{ id: 'U-002', name: 'Boris Klein', team: 'Engineering', email: 'boris@example.org', status: 'Active' },
+	{ id: 'U-003', name: 'Chiara Russo', team: 'Support', email: 'chiara@example.org', status: 'On leave' },
+];
+
+export const TableSettingsColumnOptions: FC = () => (
+	<>
+		<SampleDescription>
+			<p>
+				This example demonstrates how the table settings respect column metadata. Some columns can be hidden, reordered, or resized, while others stay locked
+				based on their <code>hidable</code>, <code>sortable</code>, and <code>resizable</code> flags.
+			</p>
+		</SampleDescription>
+
+		<KolTableStateful
+			_label="Table with column option restrictions"
+			_minWidth="auto"
+			_hasSettingsMenu
+			_headers={{
+				horizontal: [
+					[
+						{ key: 'id', label: 'ID', hidable: false, sortable: false },
+						{ key: 'name', label: 'Name' },
+						{ key: 'team', label: 'Team', sortable: false },
+						{ key: 'email', label: 'E-Mail', resizable: false },
+						{ key: 'status', label: 'Status', hidable: false, resizable: false },
+					],
+				],
+			}}
+			_tableSettings={{
+				columns: [
+					{ hidable: false, key: 'id', label: 'ID', sortable: false, visible: true, width: 15 },
+					{ key: 'name', label: 'Name', visible: true, width: 30 },
+					{ key: 'team', label: 'Team', sortable: false, visible: true, width: 20 },
+					{ key: 'email', label: 'E-Mail', resizable: false, visible: true, width: 25 },
+					{ hidable: false, key: 'status', label: 'Status', resizable: false, visible: true, width: 10 },
+				],
+			}}
+			_data={DATA}
+			className="block"
+			style={{ maxWidth: '720px' }}
+		/>
+	</>
+);

package/src/components/table/stateless-with-settings-menu.tsx

@@ -22,8 +22,25 @@ export const TableStatelessWithSettingsMenu: FC = () => (
 		<SampleDescription>
 			<p>
 				This sample shows <code>KolTableStateless</code> with the settings menu enabled via
-				<code>_hasSettingsMenu</code>.
+				<code>_hasSettingsMenu</code>. Each column demonstrates a different combination of sorting and resizing options.
 			</p>
+			<ul>
+				<li>
+					<strong>ID</strong> keeps a fixed width with <code>resizable: false</code> while still allowing sorting.
+				</li>
+				<li>
+					<strong>Name</strong> represents the default behavior with both sorting and resizing enabled.
+				</li>
+				<li>
+					<strong>Role</strong> disables sorting but keeps <code>resizable: true</code> so users can widen the column if necessary.
+				</li>
+				<li>
+					<strong>E-Mail</strong> allows sorting but locks its width with <code>resizable: false</code> to keep the layout stable.
+				</li>
+				<li>
+					<strong>Active</strong> is neither sortable nor resizable to emphasise the status indicator.
+				</li>
+			</ul>
 		</SampleDescription>
 
 		<KolTableStateless
@@ -34,11 +51,46 @@ export const TableStatelessWithSettingsMenu: FC = () => (
 			_headerCells={{
 				horizontal: [
 					[
-						{ key: 'id', label: 'ID', textAlign: 'center' },
-						{ key: 'name', label: 'Name', textAlign: 'center' },
-						{ key: 'role', label: 'Role', textAlign: 'center' },
-						{ key: 'email', label: 'E-Mail', textAlign: 'center' },
-						{ key: 'active', label: 'Active', textAlign: 'center' },
+						{
+							key: 'id',
+							label: 'ID',
+							textAlign: 'center',
+							sortDirection: 'NOS',
+							sortable: true,
+							resizable: false,
+						},
+						{
+							key: 'name',
+							label: 'Name',
+							textAlign: 'center',
+							sortDirection: 'NOS',
+							sortable: true,
+							resizable: true,
+						},
+						{
+							key: 'role',
+							label: 'Role',
+							textAlign: 'center',
+							sortDirection: 'NOS',
+							sortable: false,
+							resizable: true,
+						},
+						{
+							key: 'email',
+							label: 'E-Mail',
+							textAlign: 'center',
+							sortDirection: 'NOS',
+							sortable: true,
+							resizable: false,
+						},
+						{
+							key: 'active',
+							label: 'Active',
+							textAlign: 'center',
+							sortDirection: 'NOS',
+							sortable: false,
+							resizable: false,
+						},
 					],
 				],
 			}}