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

\n JET Progress Bar\n \n

\nThe oj-c-progress-bar element allows a user to display progress of an operation in a rectangular horizontal meter.\nIf a developer does not wish to display the exact value, a value of '-1' can be passed in to display an indeterminate value.\n\n
<oj-c-progress-bar value='{{progressValue}}'></oj-c-progress-bar>
\n\n

\n Accessibility\n \n

\n\n

\nTo meet accessibility requirements, use one or more of the following ARIA attributes to provide meaningful text describing the purpose or status of the progress bar for assistive technologies:\n

\n\n\n

\nThese ARIA attributes help assistive technologies accurately convey loading status and context to users.\n

\n\n

\nIf the progress bar is used to indicate the loading state of a specific region, the region element must have aria-describedby referencing the progress bar’s id. Include aria-busy=\"true\" for the duration of the loading. Remove or set it to \"false\" once loading is complete.\n

", "scope": "static", "tagWithoutBrackets": "oj-c-progress-bar", "tagWithBrackets": "", "domInterface": "CProgressBarElement", "ojPageTitle": "<oj-c-progress-bar>", "camelCaseName": "ProgressBar", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CProgressBarElement extends JetElement" }, "ojsignature": [ { "target": "Type", "value": "interface CProgressBarElement extends JetElement" } ], "tsdeprecated": [ { "type": "supersedes", "since": "15.0.0", "value": [ "oj-progress-bar" ] } ], "extension": { "catalog": { "category": "Controls" }, "vbdt": { "module": "oj-c/progress-bar" }, "oracle": { "icon": "oj-ux-ico-progress-linear", "uxSpecs": [ "progress-bar" ] } }, "ojmodule": "progress-bar" }, { "id": "oj-c.ProgressBar#max", "name": "max", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "member", "longname": "oj-c.ProgressBar#max", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Max", "ojshortdesc": "The maximum allowed value.", "description": "The maximum allowed value. The element's max attribute is used if it\nis provided, otherwise the default value of 100 is used.", "defaultvalue": 100 }, { "id": "oj-c.ProgressBar#value", "name": "value", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "member", "longname": "oj-c.ProgressBar#value", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Value", "ojshortdesc": "The value of the Progress Bar.", "description": "The value of the Progress Bar. The element's value attribute is used if it\nis provided, otherwise the default value of 0 is used. For indeterminate Progress, set value to -1.\nAny other negative value will default to 0.", "defaultvalue": 0 }, { "id": "oj-c.ProgressBar#edge", "name": "edge", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "member", "longname": "oj-c.ProgressBar#edge", "scope": "instance", "type": { "names": [ "\"none\"", "\"top\"" ] }, "optional": true, "ojdisplayname": "edge", "ojshortdesc": "Specifies whether the progress bar is on the top edge of a container", "description": "Whether the progress bar is positioned at the top edge of a container or not.\nIf set to 'top', the curved borders will be removed.", "ojvalues": [ { "name": "none", "description": "Not attached progress bar (default, if unspecified)", "displayName": "Not Attached Progress Bar", "type": { "names": [ "string" ] } }, { "name": "top", "description": "Progress Bar at Top Edge of container", "displayName": "Progress Bar Top Edge Container", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'none'" }, { "id": "oj-c.ProgressBar#setProperty", "name": "setProperty", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "function", "longname": "oj-c.ProgressBar#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.ProgressBar#getProperty", "name": "getProperty", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "function", "longname": "oj-c.ProgressBar#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.ProgressBar#setProperties", "name": "setProperties", "memberof": "oj-c.ProgressBar", "meta": { "filename": "progress-bar.tsx", "path": "web/components/oj-c/progress-bar" }, "kind": "function", "longname": "oj-c.ProgressBar#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" ] } } ] } ]