Checkbox

A Checkbox is a user interface control element that allows users to select one or more options from a set of options.

Playground

Live Editor

<ProvenanceCheckbox 
  id="jsx-provenance-checkbox"
  name="jsx-provenance-checkbox"
  data={[
    { label: 'New York', value: 'New York' },
    { label: 'Rome', value: 'Rome' },
    { label: 'London', value: 'London' },
    { label: 'Istanbul', value: 'Istanbul' },
    { label: 'Paris', value: 'Paris' }
  ]}
  selected={['New York', 'Rome']}
  freeze={false}
  visualize={true}
  provenanceChange={console.log} // hardcoded
  selectedChange={console.log} // hardcoded
/>

Result

Loading...

info

The above example uses React JSX and Web Components. See corresponding (static) examples for Angular and Web Components below.

checkbox.component.ts

import { Component } from '@angular/core';

@Component({
    selector: 'checkbox-root',
    templateUrl: './checkbox.component.html',
    styleUrls: ['./checkbox.component.css']
})
export class CheckboxComponent {
    data = [
        { label: 'New York', value: 'New York' },
        { label: 'Rome', value: 'Rome' },
        { label: 'London', value: 'London' },
        { label: 'Istanbul', value: 'Istanbul' },
        { label: 'Paris', value: 'Paris' }
    ];
    selected = data.map(({ value }) => value).slice(0, 2);
    freeze = false;
    visualize = true;

    provenanceChange(event) {
        console.log(event.detail);
    }

    selectedChange(event) {
        console.log(event.detail);
        // Mandatory to update the selected property manually, or use two-way binding
        selected = event.detail;
    }
}

checkbox.component.html

<provenance-checkbox 
    id="html-provenance-checkbox"
    name="html-provenance-checkbox"
    [data]="data"
    [selected]="selected"
    [freeze]="freeze"
    [visualize]="visualize"
    (provenanceChange)="provenanceChange($event)"
    (selectedChange)="selectedChange($event)"
></provenance-checkbox>

checkbox.webcomponent.ts

import { CheckboxComponent } from 'provenance-widgets';
import type { NgElement, WithProperties } from '@angular/elements'

// Create a new instance of the Checkbox
const checkbox = document.createElement("web-provenance-checkbox") as NgElement & WithProperties<CheckboxComponent>;

const data = [
    { label: 'New York', value: 'New York' },
    { label: 'Rome', value: 'Rome' },
    { label: 'London', value: 'London' },
    { label: 'Istanbul', value: 'Istanbul' },
    { label: 'Paris', value: 'Paris' }
];
// Set the properties
checkbox.data = data;
checkbox.selected = data.map(({ value }) => value).slice(0, 2);
checkbox.freeze = false;
checkbox.visualize = true;

checkbox.addEventListener('provenanceChange', (event) => {
    console.log(event.detail);
});

checkbox.addEventListener('selectedChange', (event) => {
    console.log(event.detail);
    // Mandatory to update the selected property manually
    checkbox.selected = event.detail;
});

// Append it to the DOM
document.body.appendChild(checkbox);

API

info

All widgets extend a third-party library component. See the extends property below for more information about the base component's API.

Extends	p-checkbox
Angular Selector	provenance-checkbox
Web Component Tag	web-provenance-checkbox

Properties

Name	Type	Default	Required	Description
id	string	""	Yes	Unique identifier for the element. Used by ProvenanceWidgets for internal state management and visualizations.
data	any[]	undefined	Yes	An array of objects to display as checkboxes. Each object must have a label and a value property. Alternatively, you can map your properties using label="your_label_property" and value="your_value_property".
selected	string[]	[]	No	An array of selected values. Must match the value property of the objects in the data array. Two-way binding is supported.
freeze	boolean	false	No	Whether to freeze the provenance. If true, the widget will not record any provenance, and interactions will not create/update any visualizations. NOTE: The widget does not update when the property is changed.
visualize	boolean	true	No	Whether to visualize the provenance. NOTE: The widget does not update when the property is changed.
provenance	Provenance	undefined	No	The provenance of interactions recorded by the widget. Use this property to persist, restore, modify, or reconstruct the provenance of interactions for the widget. To override the provenance, revalidate must be set to true. Two-way binding is supported.

Events

Name	EventEmitter<T>	Description
selectedChange	string[]	Emits the updated selected values when the checkbox selection changes.
provenanceChange	<Provenance>	Emits the provenance when the checkbox selection changes.