refactor(settings): polish settings UI

2026-08-24 16:39:13 +00:00 · 2026-08-01 17:09:48 +02:00
parent f0c284b708
commit 24be49ef66
49 changed files with 1946 additions and 1268 deletions
@@ -13,27 +13,30 @@ import * as Panel from '../../panel-utils/PanelUtils';
 import CustomFieldEntry from './composite/CustomFieldEntry';
 import CustomFieldForm from './composite/CustomFieldForm';

+type CustomFieldEntity = CustomField & { key: CustomFieldKey };
+
+type FormState = {
+  isOpen: boolean;
+  field?: CustomFieldEntity;
+};
+
 export default function CustomFieldSettings() {
  const { data, refetch } = useCustomFields();
-  const [isAdding, setIsAdding] = useState(false);
+  const [formState, setFormState] = useState<FormState>({ isOpen: false, field: undefined });

-  const handleInitiateCreate = () => {
-    setIsAdding(true);
-  };
+  const openNewForm = () => setFormState({ isOpen: true });
+  const openEditForm = (field: CustomFieldEntity) => setFormState({ isOpen: true, field });
+  const closeForm = () => setFormState({ isOpen: false, field: undefined });

-  const handleCancel = () => {
-    setIsAdding(false);
-  };
-
-  const handleCreate = async (customField: CustomField) => {
-    await postCustomField(customField);
-    refetch();
-    setIsAdding(false);
-  };
-
-  const handleEditField = async (key: CustomFieldKey, customField: CustomField) => {
-    await editCustomField(key, customField);
+  const handleSubmit = async (customField: CustomField) => {
+    const editing = formState.field;
+    if (editing) {
+      await editCustomField(editing.key, customField);
+    } else {
+      await postCustomField(customField);
+    }
    refetch();
+    closeForm();
  };

  const handleDelete = async (key: CustomFieldKey) => {
@@ -45,12 +48,24 @@ export default function CustomFieldSettings() {
    }
  };

+  const entries = Object.entries(data);
+
  return (
    <Panel.Section>
      <Panel.Card>
+        {formState.isOpen && (
+          <CustomFieldForm
+            onSubmit={handleSubmit}
+            onCancel={closeForm}
+            initialColour={formState.field?.colour}
+            initialLabel={formState.field?.label}
+            initialKey={formState.field?.key}
+            initialType={formState.field?.type}
+          />
+        )}
        <Panel.SubHeader>
          Custom fields
-          <Button onClick={handleInitiateCreate}>
+          <Button onClick={openNewForm}>
            New <IoAdd />
          </Button>
        </Panel.SubHeader>
@@ -66,7 +81,6 @@ export default function CustomFieldSettings() {
          </Info>
        </Panel.Section>
        <Panel.Section>
-          {isAdding && <CustomFieldForm onSubmit={handleCreate} onCancel={handleCancel} />}
          <Panel.Table>
            <thead>
              <tr>
@@ -78,7 +92,18 @@ export default function CustomFieldSettings() {
              </tr>
            </thead>
            <tbody>
-              {Object.entries(data).map(([key, { colour, label, type }]) => {
+              {entries.length === 0 && (
+                <Panel.TableEmpty
+                  title='No custom fields yet'
+                  description='Custom fields add your own columns to the rundown, and can be shown in views or used in automations.'
+                  action={
+                    <Button variant='primary' onClick={openNewForm}>
+                      Create custom field <IoAdd />
+                    </Button>
+                  }
+                />
+              )}
+              {entries.map(([key, { colour, label, type }]) => {
                return (
                  <CustomFieldEntry
                    key={key}
@@ -86,7 +111,7 @@ export default function CustomFieldSettings() {
                    colour={colour}
                    label={label}
                    type={type}
-                    onEdit={handleEditField}
+                    onEdit={() => openEditForm({ key, colour, label, type })}
                    onDelete={handleDelete}
                  />
                );
@@ -5,11 +5,14 @@ import { uploadCustomView } from '../../../../common/api/customViews';
 import { maybeAxiosError } from '../../../../common/api/utils';
 import Button from '../../../../common/components/buttons/Button';
 import Input from '../../../../common/components/input/input/Input';
+import Modal from '../../../../common/components/modal/Modal';
 import * as Panel from '../../panel-utils/PanelUtils';
 import { getFileError, getSlugError, getViewUrl, maxUploadLabel } from './customViews.utils';

 import style from './CustomViews.module.scss';

+const formId = 'custom-view-form';
+
 interface CustomViewFormProps {
  onComplete: () => void;
  onClose: () => void;
@@ -53,62 +56,72 @@ export default function CustomViewForm({ onComplete, onClose }: CustomViewFormPr
  };

  return (
-    <Panel.Indent as='form' onSubmit={handleUpload} className={style.uploadForm}>
-      <input
-        ref={fileInputRef}
-        style={{ display: 'none' }}
-        type='file'
-        onChange={handleSelectFile}
-        accept='.html,text/html'
-      />
+    <Modal
+      isOpen
+      onClose={onClose}
+      showBackdrop
+      showCloseButton
+      size='compact'
+      title='Upload custom view'
+      bodyElements={
+        <form id={formId} onSubmit={handleUpload} className={style.uploadForm}>
+          <input
+            ref={fileInputRef}
+            style={{ display: 'none' }}
+            type='file'
+            onChange={handleSelectFile}
+            accept='.html,text/html'
+          />

-      <div className={style.step}>
-        <div className={style.stepTitle}>1. Choose a name</div>
-        <Panel.Description>Name</Panel.Description>
-        <Input
-          value={slug}
-          onChange={(event) => {
-            setSlug(event.target.value);
-            setSlugDirty(true);
-          }}
-          placeholder='my-view'
-          aria-label='Custom view name'
-          autoCapitalize='off'
-          autoComplete='off'
-          fluid
-        />
-        <Panel.Description>
-          Use lowercase letters, numbers, and dashes. Example: <Panel.Highlight>my-view</Panel.Highlight>
-        </Panel.Description>
-        <Panel.Description>
-          Preview URL: <Panel.Highlight>{previewUrl}</Panel.Highlight>
-        </Panel.Description>
-        {slugDirty && slugError && <Panel.Error>{slugError}</Panel.Error>}
-      </div>
+          <div className={style.step}>
+            <div className={style.stepTitle}>1. Choose a name</div>
+            <Panel.Description>Name</Panel.Description>
+            <Input
+              value={slug}
+              onChange={(event) => {
+                setSlug(event.target.value);
+                setSlugDirty(true);
+              }}
+              placeholder='my-view'
+              aria-label='Custom view name'
+              autoCapitalize='off'
+              autoComplete='off'
+              fluid
+            />
+            <Panel.Description>
+              Use lowercase letters, numbers, and dashes. Example: <Panel.Highlight>my-view</Panel.Highlight>
+            </Panel.Description>
+            <Panel.Description>
+              Preview URL: <Panel.Highlight>{previewUrl}</Panel.Highlight>
+            </Panel.Description>
+            {slugDirty && slugError && <Panel.Error>{slugError}</Panel.Error>}
+          </div>

-      <div className={style.step}>
-        <div className={style.stepTitle}>2. Select index.html</div>
-        <Panel.Description>Upload file</Panel.Description>
-        <Panel.InlineElements wrap='wrap' className={style.filePicker}>
-          <Button onClick={() => fileInputRef.current?.click()}>
-            {selectedFile ? 'Replace index.html' : 'Choose index.html'}
+          <div className={style.step}>
+            <div className={style.stepTitle}>2. Select index.html</div>
+            <Panel.Description>Upload file</Panel.Description>
+            <Panel.InlineElements wrap='wrap' className={style.filePicker}>
+              <Button onClick={() => fileInputRef.current?.click()}>
+                {selectedFile ? 'Replace index.html' : 'Choose index.html'}
+              </Button>
+              <span className={style.fileName}>
+                {selectedFile ? `${selectedFile.name} (${Math.ceil(selectedFile.size / 1024)} KB)` : 'No file selected'}
+              </span>
+            </Panel.InlineElements>
+            <Panel.Description>Accepted: index.html only, maximum {maxUploadLabel}.</Panel.Description>
+            {fileDirty && fileError && <Panel.Error>{fileError}</Panel.Error>}
+          </div>
+        </form>
+      }
+      footerElements={
+        <>
+          {error && <Panel.Error>{error}</Panel.Error>}
+          <Button onClick={onClose}>Cancel</Button>
+          <Button variant='primary' type='submit' form={formId} loading={isUploading} disabled={!canUpload}>
+            Upload view <IoCloudUploadOutline />
          </Button>
-          <span className={style.fileName}>
-            {selectedFile ? `${selectedFile.name} (${Math.ceil(selectedFile.size / 1024)} KB)` : 'No file selected'}
-          </span>
-        </Panel.InlineElements>
-        <Panel.Description>Accepted: index.html only, maximum {maxUploadLabel}.</Panel.Description>
-        {fileDirty && fileError && <Panel.Error>{fileError}</Panel.Error>}
-      </div>
-
-      {error && <Panel.Error>{error}</Panel.Error>}
-
-      <Panel.InlineElements align='end'>
-        <Button onClick={onClose}>Cancel</Button>
-        <Button variant='primary' type='submit' loading={isUploading} disabled={!canUpload}>
-          Upload view <IoCloudUploadOutline />
-        </Button>
-      </Panel.InlineElements>
-    </Panel.Indent>
+        </>
+      }
+    />
  );
 }
@@ -37,13 +37,14 @@ export default function CustomViews() {
  return (
    <Panel.Section>
      <Panel.Card>
+        {isUploadOpen && <CustomViewForm onComplete={handleUploadComplete} onClose={() => setIsUploadOpen(false)} />}
        <Panel.SubHeader>
          Custom views
          <Panel.InlineElements>
            <Button variant='ghosted' onClick={handleRestoreDemo} disabled={hasDemoView}>
              Restore demo
            </Button>
-            <Button onClick={() => setIsUploadOpen(true)} disabled={isUploadOpen}>
+            <Button onClick={() => setIsUploadOpen(true)}>
              New <IoAdd />
            </Button>
          </Panel.InlineElements>
@@ -63,8 +64,6 @@ export default function CustomViews() {
        <Panel.Section>
          <Panel.Loader isLoading={status === 'pending'} />

-          {isUploadOpen && <CustomViewForm onComplete={handleUploadComplete} onClose={() => setIsUploadOpen(false)} />}
-
          {actionError && <Panel.Error>{actionError}</Panel.Error>}

          <CustomViewsList
@@ -1,5 +1,6 @@
 import { CustomViewSummary } from 'ontime-types';
 import { useState } from 'react';
+import { IoCloudUploadOutline } from 'react-icons/io5';

 import { deleteCustomView } from '../../../../common/api/customViews';
 import { maybeAxiosError } from '../../../../common/api/utils';
@@ -53,7 +54,17 @@ export default function CustomViewsList({ views, onOpenUpload, onMutate, onError
          </tr>
        </thead>
        <tbody>
-          {views.length === 0 && <Panel.TableEmpty handleClick={onOpenUpload} label='No custom views yet' />}
+          {views.length === 0 && (
+            <Panel.TableEmpty
+              title='No custom views yet'
+              description='Upload a self-contained index.html to serve your own view alongside the built-in ones.'
+              action={
+                <Button variant='primary' onClick={onOpenUpload}>
+                  Upload view <IoCloudUploadOutline />
+                </Button>
+              }
+            />
+          )}
          {views.map((view, index) => (
            <CustomViewsListItem
              key={view.slug}
@@ -12,6 +12,13 @@
  gap: 1rem;
 }

-.current {
-  background-color: $blue-1100 !important; // fighting zebra styles
+.formColumn {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+}
+
+.current {
+  // marker consumed by the shared Panel.Table active-row treatment
+  background-color: inherit;
 }
@@ -3,9 +3,12 @@ import { useForm } from 'react-hook-form';

 import Button from '../../../../common/components/buttons/Button';
 import Input from '../../../../common/components/input/input/Input';
+import Modal from '../../../../common/components/modal/Modal';
 import { useMutateProjectRundowns } from '../../../../common/hooks-query/useProjectRundowns';
 import * as Panel from '../../panel-utils/PanelUtils';

+const formId = 'new-rundown-form';
+
 type NewRundownFormState = {
  title: string;
 };
@@ -42,22 +45,32 @@ export function ManageRundownForm({ onClose }: ManageRundownForm) {
  }, [setFocus]);

  return (
-    <Panel.Indent as='form' onSubmit={handleSubmit(createRundown)}>
-      <Panel.Section>
-        <label>
-          <Panel.Description>Rundown title</Panel.Description>
-          <Input {...register('title')} maxLength={64} fluid placeholder='Your rundown name' />
-        </label>
-      </Panel.Section>
-      <Panel.InlineElements relation='inner' align='end'>
-        <Button variant='ghosted' disabled={isSubmitting} onClick={onClose}>
-          Cancel
-        </Button>
-        <Button type='submit' variant='primary' disabled={isSubmitting}>
-          Create rundown
-        </Button>
-      </Panel.InlineElements>
-      {errors.root && <Panel.Error>{errors.root.message}</Panel.Error>}
-    </Panel.Indent>
+    <Modal
+      isOpen
+      onClose={onClose}
+      showBackdrop
+      showCloseButton
+      size='small'
+      title='Create rundown'
+      bodyElements={
+        <form id={formId} onSubmit={handleSubmit(createRundown)}>
+          <label>
+            <Panel.Description>Rundown title</Panel.Description>
+            <Input {...register('title')} fluid placeholder='Your rundown name' maxLength={64} />
+          </label>
+        </form>
+      }
+      footerElements={
+        <>
+          {errors.root && <Panel.Error>{errors.root.message}</Panel.Error>}
+          <Button variant='ghosted' disabled={isSubmitting} onClick={onClose}>
+            Cancel
+          </Button>
+          <Button type='submit' form={formId} variant='primary' disabled={isSubmitting}>
+            Create rundown
+          </Button>
+        </>
+      }
+    />
  );
 }
@@ -153,7 +153,7 @@ export default function ManageRundowns() {
                    <tr key={id} className={cx([isLoaded && style.current])}>
                      <td>{numEntries}</td>
                      <td>
-                        {title} {isLoaded && <Tag>Loaded</Tag>}
+                        {title} {isLoaded && <Tag variant='active'>Loaded</Tag>}
                      </td>
                      <td>
                        <DropdownMenu
@@ -1,5 +1,4 @@
 import { CustomField, CustomFieldKey } from 'ontime-types';
-import { useState } from 'react';
 import { IoPencil, IoTrash } from 'react-icons/io5';

 import IconButton from '../../../../../common/components/buttons/IconButton';
@@ -7,7 +6,6 @@ import CopyTag from '../../../../../common/components/copy-tag/CopyTag';
 import Swatch from '../../../../../common/components/input/colour-input/Swatch';
 import Tag from '../../../../../common/components/tag/Tag';
 import * as Panel from '../../../panel-utils/PanelUtils';
-import CustomFieldForm from './CustomFieldForm';

 import style from '../ManagePanel.module.scss';

@@ -16,35 +14,12 @@ interface CustomFieldEntryProps {
  label: string;
  fieldKey: string;
  type: CustomField['type'];
-  onEdit: (key: CustomFieldKey, patch: CustomField) => Promise<void>;
+  onEdit: () => void;
  onDelete: (key: CustomFieldKey) => Promise<void>;
 }

 export default function CustomFieldEntry(props: CustomFieldEntryProps) {
  const { colour, label, fieldKey, type, onEdit, onDelete } = props;
-  const [isEditing, setIsEditing] = useState(false);
-
-  const handleEdit = async (patch: CustomField) => {
-    await onEdit(fieldKey, patch);
-    setIsEditing(false);
-  };
-
-  if (isEditing) {
-    return (
-      <tr>
-        <td colSpan={99}>
-          <CustomFieldForm
-            onCancel={() => setIsEditing(false)}
-            onSubmit={handleEdit}
-            initialColour={colour}
-            initialLabel={label}
-            initialKey={fieldKey}
-            initialType={type}
-          />
-        </td>
-      </tr>
-    );
-  }

  return (
    <tr>
@@ -61,7 +36,7 @@ export default function CustomFieldEntry(props: CustomFieldEntryProps) {
        </CopyTag>
      </td>
      <Panel.InlineElements relation='inner' as='td'>
-        <IconButton variant='ghosted-white' aria-label='Edit entry' onClick={() => setIsEditing(true)}>
+        <IconButton variant='ghosted-white' aria-label='Edit entry' onClick={onEdit}>
          <IoPencil />
        </IconButton>
        <IconButton variant='ghosted-destructive' aria-label='Delete entry' onClick={() => onDelete(fieldKey)}>
@@ -8,13 +8,15 @@ import Button from '../../../../../common/components/buttons/Button';
 import Info from '../../../../../common/components/info/Info';
 import SwatchSelect from '../../../../../common/components/input/colour-input/SwatchSelect';
 import Input from '../../../../../common/components/input/input/Input';
+import Modal from '../../../../../common/components/modal/Modal';
 import RadioGroup from '../../../../../common/components/radio-group/RadioGroup';
 import useCustomFields from '../../../../../common/hooks-query/useCustomFields';
-import { preventEscape } from '../../../../../common/utils/keyEvent';
 import * as Panel from '../../../panel-utils/PanelUtils';

 import style from '../ManagePanel.module.scss';

+const formId = 'custom-field-form';
+
 interface CustomFieldsFormProps {
  onSubmit: (field: CustomField) => Promise<void>;
  onCancel: () => void;
@@ -85,65 +87,77 @@ export default function CustomFieldForm({
  const isEditMode = initialKey !== undefined;

  return (
-    <Panel.Indent as='form' onSubmit={handleSubmit(setupSubmit)} onKeyDown={(event) => preventEscape(event, onCancel)}>
-      <Info>
-        Please note that images can quickly deteriorate your app&apos;s performance.
-        <br />
-        Prefer using small, and compressed images.
-      </Info>
-      <div>
-        <Panel.Description>Type</Panel.Description>
-        <RadioGroup
-          orientation='horizontal'
-          disabled={isEditMode}
-          onValueChange={(value) => setValue('type', value, { shouldDirty: true })}
-          value={watch('type')}
-          items={[
-            { value: 'text', label: 'Text' },
-            { value: 'image', label: 'Image' },
-          ]}
-        />
-      </div>
-      <div className={style.twoCols}>
-        <label>
-          <Panel.Description>Label (only alphanumeric characters are allowed)</Panel.Description>
-          {errors.label && <Panel.Error>{errors.label.message}</Panel.Error>}
-          <Input
-            {...register('label', {
-              required: { value: true, message: 'Required field' },
-              onChange: () => setValue('key', customFieldLabelToKey(getValues('label')) ?? 'N/A'),
-              validate: (value) => {
-                if (value.trim().length === 0) return 'Required field';
-                if (!checkRegex.isAlphanumericWithSpace(value))
-                  return 'Only alphanumeric characters and space are allowed';
-                if (!isEditMode) {
-                  if (isEditMode && Object.keys(data).includes(value)) return 'Custom fields must be unique';
-                }
-                return true;
-              },
-            })}
-            fluid
-          />
-        </label>
+    <Modal
+      isOpen
+      onClose={onCancel}
+      showBackdrop
+      showCloseButton
+      size='compact'
+      title={isEditMode ? 'Edit custom field' : 'Create custom field'}
+      bodyElements={
+        <form id={formId} onSubmit={handleSubmit(setupSubmit)} className={style.formColumn}>
+          <Info>
+            Please note that images can quickly deteriorate your app&apos;s performance.
+            <br />
+            Prefer using small, and compressed images.
+          </Info>
+          <div>
+            <Panel.Description>Type</Panel.Description>
+            <RadioGroup
+              orientation='horizontal'
+              disabled={isEditMode}
+              onValueChange={(value) => setValue('type', value, { shouldDirty: true })}
+              value={watch('type')}
+              items={[
+                { value: 'text', label: 'Text' },
+                { value: 'image', label: 'Image' },
+              ]}
+            />
+          </div>
+          <div className={style.twoCols}>
+            <label>
+              <Panel.Description>Label (only alphanumeric characters are allowed)</Panel.Description>
+              {errors.label && <Panel.Error>{errors.label.message}</Panel.Error>}
+              <Input
+                {...register('label', {
+                  required: { value: true, message: 'Required field' },
+                  onChange: () => setValue('key', customFieldLabelToKey(getValues('label')) ?? 'N/A'),
+                  validate: (value) => {
+                    if (value.trim().length === 0) return 'Required field';
+                    if (!checkRegex.isAlphanumericWithSpace(value))
+                      return 'Only alphanumeric characters and space are allowed';
+                    if (!isEditMode && Object.hasOwn(data, customFieldLabelToKey(value) ?? '')) {
+                      return 'Custom fields must be unique';
+                    }
+                    return true;
+                  },
+                })}
+                fluid
+              />
+            </label>

-        <label>
-          <Panel.Description>Key (use in Integrations and API)</Panel.Description>
-          <Input {...register('key')} variant='ghosted' readOnly fluid />
-        </label>
-      </div>
-      <label>
-        <Panel.Description>Colour</Panel.Description>
-        <SwatchSelect name='colour' value={colour} handleChange={(_field, value) => handleSelectColour(value)} />
-      </label>
-      {errors.root && <Panel.Error>{errors.root.message}</Panel.Error>}
-      <Panel.InlineElements relation='inner' align='end'>
-        <Button variant='ghosted' onClick={onCancel}>
-          Cancel
-        </Button>
-        <Button type='submit' variant='primary' disabled={!canSubmit} loading={isSubmitting}>
-          Save
-        </Button>
-      </Panel.InlineElements>
-    </Panel.Indent>
+            <label>
+              <Panel.Description>Key (use in Integrations and API)</Panel.Description>
+              <Input {...register('key')} variant='ghosted' readOnly fluid />
+            </label>
+          </div>
+          <label>
+            <Panel.Description>Colour</Panel.Description>
+            <SwatchSelect name='colour' value={colour} handleChange={(_field, value) => handleSelectColour(value)} />
+          </label>
+        </form>
+      }
+      footerElements={
+        <>
+          {errors.root && <Panel.Error>{errors.root.message}</Panel.Error>}
+          <Button variant='ghosted' onClick={onCancel}>
+            Cancel
+          </Button>
+          <Button type='submit' form={formId} variant='primary' disabled={!canSubmit} loading={isSubmitting}>
+            Save
+          </Button>
+        </>
+      }
+    />
  );
 }
@@ -1,30 +1,3 @@
-.emptyState {
-  padding: 3rem 1.5rem;
-  text-align: center;
-}
-
-.emptyMessage {
-  width: min(30rem, 100%);
-  margin-inline: auto;
-}
-
-.emptyTitle {
-  margin-bottom: 0.25rem;
-  color: rgba($gray-200, 0.72);
-  font-size: calc(1rem + 2px);
-  font-weight: 400;
-}
-
-.emptyBody {
-  color: rgba($gray-200, 0.55);
-  font-size: calc(1rem - 3px);
-  line-height: 1.5;
-}
-
-.emptyAction {
-  margin: 1rem auto 0;
-}
-
 .table {
  width: 100%;
  border-collapse: separate;
@@ -6,6 +6,7 @@ import { useMemo } from 'react';
 import Button from '../../../../../../../common/components/buttons/Button';
 import Tag from '../../../../../../../common/components/tag/Tag';
 import { getRundownMetadata } from '../../../../../../../common/utils/rundownMetadata';
+import * as Panel from '../../../../../panel-utils/PanelUtils';
 import { getCellValue } from './previewTableUtils';

 import style from './PreviewTable.module.scss';
@@ -123,23 +124,17 @@ export default function PreviewTable({
    }

    return (
-      <div className={style.emptyState}>
-        <div className={style.emptyMessage}>
-          <div className={style.emptyTitle}>{emptyTitle}</div>
-          <div className={style.emptyBody}>{emptyContent}</div>
-          {needsPreviewRefresh && (
-            <Button
-              className={style.emptyAction}
-              variant='primary'
-              onClick={onRefresh}
-              disabled={!canRefresh}
-              loading={isRefreshing}
-            >
+      <Panel.EmptyState
+        title={emptyTitle}
+        description={emptyContent}
+        action={
+          needsPreviewRefresh && (
+            <Button variant='primary' onClick={onRefresh} disabled={!canRefresh} loading={isRefreshing}>
              Refresh preview
            </Button>
-          )}
-        </div>
-      </div>
+          )
+        }
+      />
    );
  }