[ { "id": "oj-c.Checkbox", "name": "Checkbox", "memberof": "oj-c", "kind": "class", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "ojcomponent": true, "isvcomponent": true, "since": "16.0.0", "longname": "oj-c.Checkbox", "pack": "oj-c", "classdesc": "

\n JET Checkbox Component\n \n

\n\nCheckbox is a single standalone checkbox control. It represents a boolean value.\n\n

The Checkbox label is placed in the default slot and can be a short string or block of text\n

\n\n
\n\n<oj-c-checkbox value=\"false\">\nI Agree\n</oj-c-checkbox>\n\n
\n\n

\n Validation and Messaging\n \n

\n\n

\nFor components that support validators, any invalid values entered by the user are not pushed into the value\nif validation fails: the valid property will change but the original value will remain unchanged.\nThe same thing applies to required validation: if required is set to true and the user clears the field,\nvalid will change, but empty values will not be pushed so the original value remains unchanged.\n

\n

\nUse \n<oj-validation-group> to handle tracking valid across multiple components.\n

\n

\nAn editable component runs validation (normal or deferred) based on the action performed on it\n(either by end-user or page author), and the state it was in when the action occurred. Examples\nof actions are - creating a component, user changing the value of the component by interacting\nwith it, the app setting a value programmatically, the app calling the validate() method etc. At\nthe time the action occurs, the component could already be showing errors, or can have a deferred\nerror or have no errors.\n

\n

\nThese factors also determine whether validation errors/messages get shown to the user immediately\nor get deferred. The following sections highlight the kinds of validation that are run and how\nmessages get handled.\n

\n\n

\n Normal Validation\n \n

\nNormal validation is run in the following cases on the display value, using the converter and\nvalidators (this includes async-validators) set on the component (for components that support these properties),\n\nand validation errors are reported to user immediately.\n\n\n

\n Deferred Validation\n \n

\nDeferred validation is run in the following cases on the component value using the implicit\nrequired validator if required is true, and validation errors are deferred, i.e., not shown to user immediately.\nRefer to the Showing Deferred Messages section to\nunderstand how deferred messages can be shown.\n\n\n

\n Mixed Validation\n \n

\nEither deferred or normal validation is run in the following cases based on the state the\ncomponent is in and any validation errors encountered are either hidden or shown to user.\n\n\n

\n Showing Deferred Messages\n \n

\nDeferred validation messages are displayed only when page author requests for it explicitly in\none of the following ways:\n\n\n

\n Validators Participating in Deferred Validation\n \n

\nThe required validator is the only validator type that participates in deferred validation.\nThe required property needs to be set to true for the required validator to run.\n \n

\nTouch End User Information\n\n

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
CheckboxTap Select/unselect the checkbox
Checkbox's LabelTap Select/unselect the corresponding checkbox
\n\n

\nKeyboard End User Information\n\n

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetKeyAction
CheckboxTab InSet focus on the checkbox.\n Disabled checkboxes are not focusable.
CheckboxSpaceToggles the checkbox; If the checkbox is unselected, it will select it and vice versa.
CheckboxTabFocus goes to the next focusable item after the oj-c-checkbox or help icon if present.
CheckboxShift+TabSets focus to the previous focusable item before the oj-c-checkbox.
\n\n

\nAccessibility\n\n

\n\n

Text as a label is required in the default slot to associate with the checkbox element

", "scope": "static", "tagWithoutBrackets": "oj-c-checkbox", "tagWithBrackets": "", "domInterface": "CCheckboxElement", "ojPageTitle": "<oj-c-checkbox>", "camelCaseName": "Checkbox", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CCheckboxElement extends JetElement" }, "ojsignature": [ { "target": "Type", "value": "interface CCheckboxElement extends JetElement" } ], "tsdeprecated": [ { "type": "production", "since": "17.0.0" } ], "extension": { "catalog": { "category": "Forms" }, "vbdt": { "module": "oj-c/checkbox", "defaultColumns": 6, "minColumns": 2 }, "oracle": { "icon": "oj-ux-ico-checkbox-on", "uxSpecs": [ "checkbox" ] } }, "ojmodule": "checkbox" }, { "id": "oj-c.Checkbox#containerReadonly", "name": "containerReadonly", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#containerReadonly", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Container Readonly", "ojshortdesc": "Specifies whether an ancestor container, like oj-c-form-layout, is readonly.", "description": "Specifies whether an ancestor container, like oj-c-form-layout, is readonly.\nThis affects whether a readonly component renders in full or mixed readonly mode." }, { "id": "oj-c.Checkbox#columnSpan", "name": "columnSpan", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#columnSpan", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Column Span", "ojshortdesc": "Specifies how many columns this component should span.", "description": "Specifies how many columns this component should span.\nThis only takes effect when this component is a child of a form layout\nthat has direction 'row'.", "defaultvalue": 1 }, { "id": "oj-c.Checkbox#disabled", "name": "disabled", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#disabled", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Disabled", "ojshortdesc": "Specifies whether the component is disabled.", "description": "Whether the component is disabled. The default is false.\n\n

\nWhen the disabled property changes due to programmatic\nintervention, the component may clear messages and run validation in some cases.
\n

    \n
  • when a required component is initialized as disabled\nvalue=\"{{currentValue}}\" required disabled,\ndeferred validation is skipped.
    • \n
  • when a disabled component is enabled,\n
      \n
    • if component is invalid and showing messages then all component messages are cleared,\n and full validation run using the display value.\n
        \n
      • if there are validation errors, they are shown.
        • \n
      • if no errors result from the validation, the value\n property is updated. Page authors can listen to the valueChanged\n event to clear custom errors.
        • \n
      \n
      • \n\n
    • if component is valid and has no errors then deferred validation is run.\n
        \n
      • if there is a deferred validation error, then the valid property is updated.
        • \n
      \n
      • \n
    • if component is invalid and deferred errors then component messages are cleared and\n deferred validation re-run.\n
        \n
      • if there is a deferred validation error, then the valid property is updated.
        • \n
      \n
      • \n
    \n
    • \n
  • when enabled component is disabled then no validation is run and the component appears\ndisabled.
    • \n
\n

", "defaultvalue": false }, { "id": "oj-c.Checkbox#displayOptions", "name": "displayOptions", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#displayOptions", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Display Options", "description": "Display options for auxiliary content that describes whether or not it should be displayed.", "tstype": [ { "target": "Type", "value": "oj-c.Checkbox.DisplayOptionsProps", "jsdocOverride": true } ] }, { "id": "oj-c.Checkbox#help", "name": "help", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#help", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Help", "description": "Form component help information.", "tstype": [ { "target": "Type", "value": "oj-c.Checkbox.Help", "jsdocOverride": true } ] }, { "id": "oj-c.Checkbox#helpHints", "name": "helpHints", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#helpHints", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Help Hints", "description": "The helpHints object contains a definition property, sourceText property, and a source property.", "tstype": [ { "target": "Type", "value": "oj-c.Checkbox.HelpHints", "jsdocOverride": true } ] }, { "id": "oj-c.Checkbox#messagesCustom", "name": "messagesCustom", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#messagesCustom", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Messages Custom", "ojwriteback": true, "ojshortdesc": "List of custom component messages", "description": "List of messages an app would add to the component when it has business/custom validation\nerrors that it wants the component to show. This allows the app to perform further validation\nbefore sending data to the server. When this option is set the message shows to the\nuser right away. To clear the custom message, set messagesCustom\nback to an empty array.
\n

\nSee the Validation and Messages section\nfor details on when the component clears messagesCustom;\nfor example, when full validation is run.\n

", "defaultvalue": "[]", "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true } ] }, { "id": "oj-c.Checkbox#readonly", "name": "readonly", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#readonly", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Readonly", "ojshortdesc": "Whether the component is readonly", "description": "

\nWhether the component is readonly. The readonly property sets or returns whether an element\nis readonly, or not. A readonly element cannot be modified. However, a user can tab to it,\nhighlight it, focus on it, and copy the text from it. If you want to prevent the user from\ninteracting with the element, use the disabled property instead.\n

\n

\nIf the property value is not set either directly on the component or inherited from\na parent form layout, then the property is treated as if its value were false.\n

" }, { "id": "oj-c.Checkbox#readonlyUserAssistanceShown", "name": "readonlyUserAssistanceShown", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#readonlyUserAssistanceShown", "scope": "instance", "type": { "names": [ "\"none\"", "\"confirmationAndInfoMessages\"" ] }, "optional": true, "ojdisplayname": "ReadonlyUserAssistanceShown", "ojshortdesc": "Specifies which user assistance types should be shown when the component is readonly.", "description": "

\nSpecifies which user assistance types should be shown when the component is readonly.\n

", "defaultvalue": "'none'" }, { "id": "oj-c.Checkbox#required", "name": "required", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#required", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Required", "ojshortdesc": "Specifies whether or not the component is required.", "description": "

\nThis property set to false implies that a value is not required to be provided by the user.\nThis is the default.\nThis property set to true implies that a value is required to be provided by the user.\n

\n

\nIn the Redwood theme, by default, a Required text is rendered inline when the field is empty.\n

\n

The Required error text is based on Redwood UX designs, and it is not recommended that\nit be changed.\nTo override the required error message,\nuse the required-message-detail attribute.\nThe component's label text is passed in as a token {label} and can be used in the message detail.\n

\n

When required is set to true, an implicit\nrequired validator is created, i.e.,\nnew RequiredValidator(). The required validator is the only\nvalidator to run during initial render, and its error is not shown to the user at this time;\nthis is called deferred validation. The required validator also runs during normal validation;\nthis is when the errors are shown to the user.\nSee the Validation and Messaging section for details.\n

\n

\nWhen the required property changes due to programmatic intervention,\nthe component may clear component messages and run validation, based on the current state it's in.
\n\n

Running Validation when required property changes

\n
    \n
  • if component is valid when required is set to true, then it runs deferred validation on\nthe value property. If the field is empty, the valid state is invalidHidden. No errors are\nshown to the user.\n
    • \n
  • if component is valid when required is set from true to false, then no validation is run.\n
    • \n
  • if component is invalid and has deferred messages (invalidHidden) when required is set to false, then\ncomponent messages are cleared (messages-custom messages are not cleared)\nbut no deferred validation is run because required is false.\n
    • \n
  • if component is invalid and currently showing invalid messages (invalidShown) when required is changed\nto either true or false, then\ncomponent messages are cleared and normal validation is run using the current display value.\n
      \n
    • if there are validation errors, then value\n property is not updated and the error is shown.\n
      • \n
    • if no errors result from the validation, the value\n property is updated; page author can listen to the valueChanged\n event on the component to clear custom errors.
      • \n
    \n
    • \n
\n\n

Clearing Messages when required property changes

\n
    \n
  • Only messages created by the component, like validation messages, are cleared when the required property changes.
    • \n
  • messagesCustom property is not cleared.
    • \n
\n\n

", "defaultvalue": false }, { "id": "oj-c.Checkbox#userAssistanceDensity", "name": "userAssistanceDensity", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#userAssistanceDensity", "scope": "instance", "type": { "names": [ "\"compact\"", "\"reflow\"", "\"efficient\"" ] }, "optional": true, "ojdisplayname": "User Assistance Density", "ojshortdesc": "Specifies the density of the form component's user assistance presentation.", "description": "

\nSpecifies the density of the form component's user assistance presentation. It can be shown inline with\nreserved rows to prevent reflow if a user assistance text shows up, inline without reserved rows that would\nreflow if a user assistance text shows up, or it can be shown compactly in a popup instead.\n

\n

\nIf the property value is not set either directly on the component or inherited from\na parent form layout, then the property is treated as if its value were \"reflow\".\n

", "ojvalues": [ { "name": "reflow", "description": "Messages and required are shown inline under the field with no reserved space. Help & hints will appear in a popup with a help icon.", "displayName": "Reflow", "type": { "names": [ "string" ] } }, { "name": "efficient", "description": "Messages and required are shown inline under the field with reserved space. Help & hints will appear in a popup with a help icon.", "displayName": "Efficient", "type": { "names": [ "string" ] } }, { "name": "compact", "description": "Messages and required are shown inline under the field with reserved space. Help & hints will appear in a popup with a help icon.", "displayName": "Compact", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true }, { "id": "oj-c.Checkbox#requiredMessageDetail", "name": "requiredMessageDetail", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#requiredMessageDetail", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Required Message Detail", "ojshortdesc": "Overrides the default Required error message.", "description": "

\nThe component-specific message detail when the required validation fails.\nIf the component needs a required validation error message that is different from the default,\nset this property. It should be a translated string.\n

" }, { "id": "oj-c.Checkbox#valid", "name": "valid", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#valid", "scope": "instance", "type": { "names": [ "\"pending\"", "\"valid\"", "\"invalidHidden\"", "\"invalidShown\"" ] }, "optional": true, "ojdisplayname": "Valid", "ojwriteback": true, "readonly": true, "ojshortdesc": "Specifies how the valid state of the component", "description": "

\nThe current valid state of the component. It is evaluated on initial render.\nIt is re-evaluated\n

    \n
  • when messagesCustom is updated,\n since messagesCustom can be added by the app developer any time.
    • \n
  • when showMessages() is called. Since showMessages() moves the\n hidden messages into messages shown,\n if the valid state was \"invalidHidden\" then it would become \"invalidShown\".
    • \n
  • when the required property has changed. If a component is empty and has required\n set, the valid state may be \"invalidHidden\" (if no invalid messages are being shown as well).\n If required property is removed, the valid state would change to \"valid\".
    • \n
\n

\n

\n Note: New valid states may be added to the list of valid values in future releases.\n Any new values will start with \"invalid\"\n if it is an invalid state, \"pending\" if it is pending state,\n and \"valid\" if it is a valid state.\n

", "ojvalues": [ { "name": "valid", "description": "The component is valid", "displayName": "Valid", "type": { "names": [ "string" ] } }, { "name": "pending", "description": "The component is waiting for the validation state to be determined. The 'pending' state is set at the start of the convert/validate process.", "displayName": "Pending", "type": { "names": [ "string" ] } }, { "name": "invalidHidden", "description": "The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity 'error'.", "displayName": "Invalid Hidden", "type": { "names": [ "string" ] } }, { "name": "invalidShown", "description": "The component has invalid messages showing. An invalid message is one with severity 'error'.", "displayName": "Invalid Shown", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true }, { "id": "oj-c.Checkbox#value", "name": "value", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#value", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Value", "ojwriteback": true, "ojshortdesc": "The value of the component.", "description": "The value of the component.\n\n

\nWhen value property changes due to programmatic\nintervention, the component always clears all messages\nincluding messagesCustom, runs deferred validation, and\nalways refreshes UI display value.\n

\n\n

\nWhen the checkbox is cleared and the value is committed, the value\nproperty is set to false.\n

\n\n

Running Validation

\n
    \n
  • component always runs deferred validation; the\nvalid property is updated with the result.
    • \n
", "defaultvalue": false }, { "id": "oj-c.Checkbox#blur", "name": "blur", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#blur", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Blurs the input field.", "description": "Blurs the input field.", "ojhidden": true }, { "id": "oj-c.Checkbox#focus", "name": "focus", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#focus", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Focuses the input field.", "description": "Focuses the input field.", "ojhidden": true }, { "id": "oj-c.Checkbox#showMessages", "name": "showMessages", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#showMessages", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Takes all deferred messages and shows them.", "description": "Takes all deferred messages and shows them.\nIt then updates the valid property;\ne.g., if the valid state was \"invalidHidden\" before showMessages(),\nthe valid state will become \"invalidShown\" after showMessages().\nIf there were no deferred messages this method simply returns." }, { "id": "oj-c.Checkbox#reset", "name": "reset", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#reset", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Resets the component by clearing all messages.", "description": "Resets the component by clearing all messages and messagesCustom attribute\nand updates the component's display value using the attribute value.\nUser entered value will be erased when this method is called." }, { "id": "oj-c.Checkbox#validate", "name": "validate", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#validate", "scope": "instance", "returns": [ { "type": { "names": [ "Promise" ] }, "description": "The Promise resolves to \"valid\" if the component is disabled or readonly.\nThe Promise resolves to \"invalid\" if there were errors." } ], "ojshortdesc": "If enabled, validates the component's display value.", "description": "If enabled, validates the component's display value (or undefined if display value is empty) and updates the value\noption by performing the following steps.\n
    \n
  1. All messages are cleared, including custom messages added by the app.
    2. \n
  2. \n At the end of validation if there are errors, the messages are shown.\n If there were no errors, then the value option is updated.\n
    3. \n
\n

If the component is readonly or disabled, returns a Promise that resolves to 'valid'\nwithout doing any validation.

" }, { "id": "oj-c.Checkbox#setProperty", "name": "setProperty", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#setProperty", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.", "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.", "params": [ { "name": "property", "description": "The property name to set. Supports dot notation for subproperty access.", "type": { "names": [ "string" ] } }, { "name": "value", "description": "The new value to set the property to.", "type": { "names": [ "any" ] } } ] }, { "id": "oj-c.Checkbox#getProperty", "name": "getProperty", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#getProperty", "scope": "instance", "returns": [ { "type": { "names": [ "any" ] } } ], "ojshortdesc": "Retrieves the value of a property or a subproperty.", "description": "Retrieves the value of a property or a subproperty.", "params": [ { "name": "property", "description": "The property name to get. Supports dot notation for subproperty access.", "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Checkbox#setProperties", "name": "setProperties", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "function", "longname": "oj-c.Checkbox#setProperties", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Performs a batch set of properties.", "description": "Performs a batch set of properties.", "params": [ { "name": "properties", "description": "An object containing the property and value pairs to set.", "type": { "names": [ "object" ] } } ] }, { "id": "oj-c.Checkbox#Default", "name": "Default", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "kind": "member", "longname": "oj-c.Checkbox#Default", "scope": "instance", "ojdisplayname": "Default", "description": "The default slot is the content associated with the checkbox. This can be a label or a block of text.", "ojshortdesc": "The default slot is the content associated with the checkbox. This can be a label or a block of text.", "ojchild": true }, { "id": "oj-c.Checkbox.touchDoc", "name": "touchDoc", "kind": "member", "longname": "oj-c.Checkbox.touchDoc", "description": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
CheckboxTap Select/unselect the checkbox
Checkbox's LabelTap Select/unselect the corresponding checkbox
", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "ojfragment": true }, { "id": "oj-c.Checkbox.keyboardDoc", "name": "keyboardDoc", "kind": "member", "longname": "oj-c.Checkbox.keyboardDoc", "description": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetKeyAction
CheckboxTab InSet focus on the checkbox.\n Disabled checkboxes are not focusable.
CheckboxSpaceToggles the checkbox; If the checkbox is unselected, it will select it and vice versa.
CheckboxTabFocus goes to the next focusable item after the oj-c-checkbox or help icon if present.
CheckboxShift+TabSets focus to the previous focusable item before the oj-c-checkbox.
", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "ojfragment": true }, { "id": "oj-c.Checkbox.DisplayOptionsProps", "name": "DisplayOptionsProps", "kind": "typedef", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "longname": "oj-c.Checkbox.DisplayOptionsProps", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Display options for auxiliary content that determines whether or not it should be displayed.", "properties": [ { "name": "messages", "description": "Display options for auxiliary message text.", "optional": true, "type": { "names": [ "\"none\"", "\"display\"" ] }, "defaultvalue": "'display'" } ] }, { "id": "oj-c.Checkbox.Help", "name": "Help", "kind": "typedef", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "longname": "oj-c.Checkbox.Help", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Form component help information.", "properties": [ { "name": "instruction", "description": "A type of user assistance text. User assistance text is used to provide guidance to\nhelp the user understand what data to enter or select.", "optional": true, "type": { "names": [ "string" ] }, "defaultvalue": "''" } ] }, { "id": "oj-c.Checkbox.HelpHints", "name": "HelpHints", "kind": "typedef", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "longname": "oj-c.Checkbox.HelpHints", "type": { "names": [ "Object" ] }, "scope": "static", "description": "The helpHints object contains a definition property and a source property.", "properties": [ { "name": "definition", "description": "A type of user assistance text. User assistance text is used to provide guidance to help\nthe user understand what data to enter or select. help-hints could come from a help system.", "optional": true, "type": { "names": [ "string" ] }, "defaultvalue": "''" }, { "name": "source", "description": "Help source URL associated with the component.", "optional": true, "type": { "names": [ "string" ] }, "defaultvalue": "''" }, { "name": "sourceText", "description": "Custom text to be used for the source link.", "optional": true, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Checkbox.ComponentMessageItem", "name": "ComponentMessageItem", "kind": "typedef", "memberof": "oj-c.Checkbox", "meta": { "filename": "checkbox.tsx", "path": "web/components/oj-c/checkbox" }, "longname": "oj-c.Checkbox.ComponentMessageItem", "type": { "names": [ "Object" ] }, "scope": "static", "description": "A type for a single component message", "properties": [ { "name": "summary", "optional": true, "type": { "names": [ "string" ] } }, { "name": "detail", "optional": true, "type": { "names": [ "string" ] } }, { "name": "severity", "optional": true, "type": { "names": [ "\"error\"", "\"confirmation\"", "\"info\"", "\"warning\"" ] } } ] } ]