Site color

Choose your site’s color palette.

Saved on this device.

FormSubmit

FormSubmitSubmission action

Make the next step clear. A labelled submit button with every shared tone and visual treatment.

Forms & input

Submit a meaningful value

The button triggers the form’s submit event, including when the user submits from the text field.

FormSubmit in contextCOMPOSITION

The live preview handles submission locally and shows the resulting value.

<RegorApp id="form-submit-demo" src="./playground.ts"/>
import {
  defineButtonComponents,
  defineFlexComponents,
  defineFormComponents,
  defineFormInputField,
  definePanelComponents,
} from '@purestack/ts-components'
import { createApp, defineComponent, html, type Ref, ref } from 'regor'
import { mountFormAppearanceGalleries } from '../appearance'

export interface FormSubmitExample {
  releaseTitle: Ref<string>
  savedTitle: Ref<string>
  submit: (event: Event) => void
}

const formSubmitExampleTemplate = html`<Panel bodyClass="p-4">
  <AppForm @submit.prevent="submit">
    <FormInputField
      id="submit-title"
      label="Release title"
      name="release"
      :model="releaseTitle"
      :required="true"/>
    <FormSubmit label="Save release title" tone="accent"/>
    <FormStatus tone="success" :hidden="!savedTitle">
      Saved locally: {{ savedTitle }}
    </FormStatus>
  </AppForm>
</Panel>`

function createFormSubmitExample(): FormSubmitExample {
  const releaseTitle = ref('Preview release')
  const savedTitle = ref('')
  return {
    releaseTitle,
    savedTitle,
    submit: (event) => {
      const form = event.target as HTMLFormElement
      if (form.reportValidity()) savedTitle(releaseTitle())
    },
  }
}

const component = defineComponent<FormSubmitExample>(
  formSubmitExampleTemplate,
  {
    context: createFormSubmitExample,
  },
)

createApp(
  {
    components: {
      FormSubmitExample: component,

      ...defineFlexComponents(),
      ...definePanelComponents(),
      ...defineButtonComponents(),
      ...defineFormComponents(),
      ...defineFormInputField(),
    },
  },
  { selector: 'app#form-submit-demo', template: html`<FormSubmitExample/>` },
)

mountFormAppearanceGalleries()

Choose the action emphasis

The disabled fieldset keeps this visual comparison from triggering a form action.

Submit treatments
<fieldset disabled class="p-3">
  <legend>Submit treatments</legend>
  <Flex wrap="true">
    <FormSubmit label="Save changes" tone="accent" />
    <FormSubmit label="Request review" tone="neutral" variant="outline" />
  </Flex>
</fieldset>

All semantic tones

All ten tones are visible at once. The control’s label and content explain the intent independently of color.

All ten semantic tonesCOMPOSITION

Each sample is interactive and keeps its own local state. Switch the site theme to compare both palettes.

All visual variants

All eighteen supported treatments, shown in accent. Tone and variant are independent, so any treatment can be combined with a semantic tone.

All eighteen visual variantsCOMPOSITION

Each sample is interactive and keeps its own local state. Switch the site theme to compare both palettes.

Submit semantics

FormSubmit exposes label, tone, and variant and renders Btn with type="submit". Place it inside a form or pass a native form attribute for an external owner. Native name, value, and disabled attributes pass through to the button; application submission belongs to the form handler.

<AppForm @submit.prevent="save">
  <FormSubmit label="Save draft" tone="accent" name="intent" value="draft"/>
</AppForm>
<FormSubmit label="Save outside the form" form="project-form" variant="outline"/>

Behavior and accessibility

FormSubmit renders Btn with type submit. Put submission logic on the form to support keyboard submission and multiple submit paths. Use a complete label; this component has no default content slot.

API reference

FormSubmit contract

Props below are the public template API. RefOrValue accepts a literal or a reactive ref; bind refs with a colon-prefixed attribute. Native attributes and events can be passed through the component root.

label

RefOrValue<string>
Default
not set

Visible label. Use language that describes the control or value in its surrounding context.

tone

RefOrValue<SemanticTone>
Default
inherited

Semantic intent: neutral, accent, secondary, info, success, warning, danger, feature, custom or ghost. The active skin supplies the colors.

variant

RefOrValue<ComponentVariant>
Default
solid

Visual treatment. Accepts solid, surface, surfaceAlt, spotlight, glass, flat, flatAlt, flatSolid, outlineFill, outline, subtle, subtleBtn, link, sheen, underline, rail, bracket or none.

Composition

No slots. Register defineFormComponents and defineButtonComponents. Use Btn type="submit" directly when you need its wider API, such as disabled or icons.