Checkbox

Use a TypeScript application with a CSS-capable bundler. Install @blukavantui/community@1.1.0 from npm, or install the matching downloaded archive.

// In your test application’s package.json dependencies:
"@blukavantui/community": "1.1.0"

Run npm install in that test application to install the component package. Load the theme once and the component stylesheet shown in the adapter. Create an empty host in your view:

<div id="example"></div>

This reusable adapter follows the Button and TimePicker guide pattern. Its types come from the factory, so required options stay required. Attach the host first; mount once per view and retain the handle.

import { createCheckbox } from '@blukavantui/community/checkbox'
import '@blukavantui/community/theme.css'
import '@blukavantui/community/checkbox.css'

type Options = NonNullable<Parameters<typeof createCheckbox>[1]>
type Events = NonNullable<Parameters<typeof createCheckbox>[2]>

export function mount(host: HTMLElement, options: Options, events: Events = {}) {
  const instance = createCheckbox(host, options, events)
  return { instance, update: (patch: Partial<Options>) => instance.update(patch), destroy: () => instance.destroy() }
}

User interaction calls Change; update() and reset() do not. Synchronize your application state after either method. Clear a stale Error before validate(), and validate again in your application before saving. These fields expose Change and Blur; TextInput also exposes Action.

The working example stores values in application variables. If the host is inside a form, a non-canceled form reset restores initial component values; synchronize your store after that reset and clear any application errors explicitly.

Use: Checked, Indeterminate, Change

Use Checked for the stored Boolean and Indeterminate for a partially selected parent. A user toggle clears the mixed state. Recompute both from child selections when building a “select all” control.

Use: Required, Error, validate

Clear an old Error, run validate(), then apply an application message if needed. A checked required checkbox is valid; use your own server validation before saving.

Save this as checkbox.ts, import its mount function and pass your attached host. It includes application state, interactive controls and a destroy handler.

Download the editable TypeScript example ↓

import { createCheckbox } from '@blukavantui/community/checkbox'
import '@blukavantui/community/theme.css'
import '@blukavantui/community/checkbox.css'

export function mount(host: HTMLElement) {
  const root = document.createElement('section')
  const target = document.createElement('div')
  const status = document.createElement('p')
  status.setAttribute('role', 'status')
  const reset = document.createElement('button')
  reset.type = 'button'; reset.textContent = 'Reset selection'
  const check = document.createElement('button')
  check.type = 'button'; check.textContent = 'Check acceptance'
  root.append(target, status, check, reset); host.append(root)
  let accepted = false
  const render = () => { status.textContent = `Accepted: ${accepted}` }
  const instance = createCheckbox(target, {
    Name: 'accepted', Label: 'I accept the terms', Required: true,
    Checked: accepted, Description: 'Required before continuing.',
  }, { Change(value) { accepted = value; instance.update({ Error: '' }); render() } })
  const listeners = new AbortController()
  reset.addEventListener('click', () => {
    instance.update({ Error: '' }); instance.reset()
    accepted = instance.getValue(); render() // reset does not emit Change
  }, { signal: listeners.signal })
  check.addEventListener('click', () => {
    instance.update({ Error: '' })
    const valid = instance.validate()
    instance.update({ Error: valid ? '' : 'Accept the terms before continuing.' })
    status.textContent = valid ? 'Ready to continue.' : 'Acceptance is required.'
  }, { signal: listeners.signal })
  render()
  return { instance, destroy() { listeners.abort(); instance.destroy(); root.remove() } }
}

• Use Tab to reach the control. Space toggles choices; radio groups support arrow navigation. Inputs retain standard text-editing shortcuts.
• Check required, disabled and read-only states; verify reset and programmatic updates also synchronize your application state.
• Call the example handle’s destroy() when the view is removed. Abort your application listeners and requests; ignore any asynchronous result after disposal.
• Mount again and confirm there is one instance and one callback per interaction.

In Manage Dependencies, select Checkbox from BluKavantUi_Community_Inputs, together with the structures and public actions used by its API. Refresh existing references before publishing your consumer. Inherit the shared Community theme in your application's theme.

ExampleScreen — Screen (your application)
└─ ExistingLayout — referenced Layout Block instance (child of ExampleScreen)
   └─ Content — existing slot on ExistingLayout
      └─ ComponentRegion — Container (child of that slot)
         └─ MainComponent — BluKavantUi_Community_Inputs.Checkbox Block instance (child of ComponentRegion)

Reuse your screen’s existing Layout and its content slot; do not add a second layout. If your Layout names that slot differently, use its actual content slot. ComponentRegion is a new Container; MainComponent is a referenced Block instance.

Create local variables on ExampleScreen for the values your application changes. Use the exact native types below; lists are typed OutSystems Lists, while inputs ending in Json are Text containing the documented JSON. Bind each MainComponent.Input to its matching StateInput local. Constants can instead use the default directly. Fill required data from your Aggregate or Data Action before enabling interaction.

For each event you use, create the named screen Client Action below. Add its listed input parameters with the exact types. Select that action on MainComponent's event property, then enter each mapping explicitly. Event arguments and screen locals are different scopes.

These custom controls do not automatically participate in OutSystems Form.Valid. Validate your bound screen state, assign Error text for invalid fields, and call your own Server Action only when valid. Validate again on the server. Required is a runtime field requirement, not a mandatory Block input.

Publish the consumer, supply representative data, trigger each connected event and inspect the mapped arguments. Check a failed request, a retry and leaving/reopening the screen. The table describes the native contract; the Web recipes can contain capabilities with different native names or availability. Use these native names and the API tab as the authority for Service Studio.