@oracle/oraclejet-core-pack 14.0.0

package/oj-c/select-single/component.json

@@ -0,0 +1,545 @@
+{
+  "name": "select-single",
+  "version": "1.0.0",
+  "jetVersion": "^14.0.0",
+  "type": "composite",
+  "pack": "oj-c",
+  "implements": [
+    "CSelectSingleElement"
+  ],
+  "displayName": "SelectSingle",
+  "description": "A select single provides support for single-select and search filtering",
+  "help": "oj-c.SelectSingle.html",
+  "main": "oj-c/select-single",
+  "extension": {
+    "vbdt": {
+      "module": "oj-c/select-single",
+      "defaultColumns": 6,
+      "minColumns": 2
+    },
+    "oracle": {
+      "icon": "oj-ux-ico-select",
+      "uxSpecs": [
+        "select-single-items"
+      ]
+    }
+  },
+  "propertyLayout": [
+    {
+      "propertyGroup": "common",
+      "items": [
+        "disabled",
+        "labelHint",
+        "placeholder",
+        "readonly",
+        "required",
+        "virtualKeyboard"
+      ]
+    },
+    {
+      "propertyGroup": "data",
+      "items": [
+        "data",
+        "itemText",
+        "value",
+        "valueItem"
+      ]
+    }
+  ],
+  "since": "14.0.0",
+  "properties": {
+    "containerReadonly": {
+      "type": "boolean",
+      "description": "Specifies whether an ancestor container, like oj-form-layout, is readonly.",
+      "displayName": "Container Readonly",
+      "help": "#containerReadonly",
+      "binding": {
+        "consume": {
+          "name": "containerReadonly"
+        }
+      }
+    },
+    "data": {
+      "type": "object|null",
+      "description": "Specifies whether the component is disabled.",
+      "displayName": "Data",
+      "help": "#data",
+      "value": null
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Specifies whether the component is disabled.",
+      "displayName": "Disabled",
+      "help": "#disabled",
+      "value": false
+    },
+    "displayOptions": {
+      "type": "object",
+      "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
+      "displayName": "Display Options",
+      "help": "#displayOptions",
+      "properties": {
+        "messages": {
+          "type": "string",
+          "enumValues": [
+            "display",
+            "none"
+          ],
+          "value": "display"
+        }
+      }
+    },
+    "help": {
+      "type": "object",
+      "description": "Form component help information.",
+      "displayName": "Help",
+      "help": "#help",
+      "properties": {
+        "instruction": {
+          "type": "string",
+          "value": ""
+        }
+      }
+    },
+    "helpHints": {
+      "type": "object",
+      "description": "The helpHints object contains a definition property and a source property.",
+      "displayName": "Help Hints",
+      "help": "#helpHints",
+      "properties": {
+        "definition": {
+          "type": "string",
+          "value": ""
+        },
+        "source": {
+          "type": "string",
+          "value": ""
+        },
+        "sourceText": {
+          "type": "string"
+        }
+      }
+    },
+    "itemText": {
+      "type": "string|number|function",
+      "description": "Specifies how to get the text string to render for a data item.",
+      "displayName": "Item Text",
+      "help": "#itemText",
+      "required": true
+    },
+    "labelEdge": {
+      "type": "string",
+      "description": "Specifies how the label is positioned for the component",
+      "displayName": "Label Edge",
+      "help": "#labelEdge",
+      "propertyEditorValues": {
+        "inside": {
+          "description": "The label floats over the input element, but moves up on focus or when the component has a value (default, if unspecified).",
+          "displayName": "Inside"
+        },
+        "none": {
+          "description": "The component will not create a label, but instead set the aria-label property on the input element.",
+          "displayName": "None"
+        },
+        "start": {
+          "description": "The label will be placed before the start of the component.",
+          "displayName": "Start"
+        },
+        "top": {
+          "description": "The label will be placed on top of the component.",
+          "displayName": "Top"
+        }
+      },
+      "enumValues": [
+        "start",
+        "none",
+        "top",
+        "inside"
+      ],
+      "binding": {
+        "consume": {
+          "name": "containerLabelEdge"
+        }
+      }
+    },
+    "labelHint": {
+      "type": "string",
+      "description": "Represents a hint for rendering a label on the component.",
+      "displayName": "Label Hint",
+      "help": "#labelHint",
+      "required": true,
+      "translatable": true
+    },
+    "labelStartWidth": {
+      "type": "string",
+      "description": "The width of the label when labelEdge is 'start'",
+      "displayName": "Label Start Width",
+      "help": "#labelStartWidth",
+      "binding": {
+        "consume": {
+          "name": "labelWidth"
+        }
+      }
+    },
+    "labelWrapping": {
+      "type": "string",
+      "description": "Should the labels wrap or truncate when there is not enough available space.",
+      "displayName": "Label Wrapping",
+      "help": "#labelWrapping",
+      "propertyEditorValues": {
+        "truncate": {
+          "description": "Label will truncate if needed.",
+          "displayName": "Truncate"
+        },
+        "wrap": {
+          "description": "Label will wrap if needed.",
+          "displayName": "Wrap"
+        }
+      },
+      "enumValues": [
+        "wrap",
+        "truncate"
+      ],
+      "binding": {
+        "consume": {
+          "name": "labelWrapping"
+        }
+      }
+    },
+    "messagesCustom": {
+      "type": "Array<object>",
+      "description": "List of custom component messages",
+      "displayName": "Messages Custom",
+      "help": "#messagesCustom",
+      "extension": {
+        "vbdt": {
+          "itemProperties": {
+            "summary": {
+              "type": "string"
+            },
+            "detail": {
+              "type": "string"
+            },
+            "severity": {
+              "type": "string",
+              "enumValues": [
+                "error",
+                "confirmation",
+                "info",
+                "warning"
+              ]
+            }
+          }
+        }
+      },
+      "writeback": true,
+      "value": []
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "The placeholder text to set on the element.",
+      "displayName": "Placeholder",
+      "help": "#placeholder",
+      "translatable": true
+    },
+    "readonly": {
+      "type": "boolean",
+      "description": "Whether the component is readonly",
+      "displayName": "Readonly",
+      "help": "#readonly",
+      "binding": {
+        "consume": {
+          "name": "containerReadonly"
+        }
+      },
+      "value": false
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Specifies whether or not the component is required.",
+      "displayName": "Required",
+      "help": "#required",
+      "value": false
+    },
+    "requiredMessageDetail": {
+      "type": "string",
+      "description": "Overrides the default Required error message.",
+      "displayName": "Required Message Detail",
+      "help": "#requiredMessageDetail",
+      "translatable": true
+    },
+    "textAlign": {
+      "type": "string",
+      "description": "Specifies how the text is aligned within the text field",
+      "displayName": "Text Align",
+      "help": "#textAlign",
+      "propertyEditorValues": {
+        "start": {
+          "description": "Aligns text left when reading direction is ltr and right when reading direction is rtl (default, if unspecified).",
+          "displayName": "Start"
+        },
+        "end": {
+          "description": "Aligns text right when reading direction is ltr and left when reading direction is rtl.",
+          "displayName": "End"
+        },
+        "right": {
+          "description": "Aligns text right regardless of reading direction, often used for numbers.",
+          "displayName": "Right"
+        }
+      },
+      "enumValues": [
+        "start",
+        "right",
+        "end"
+      ]
+    },
+    "userAssistanceDensity": {
+      "type": "string",
+      "description": "Specifies the density of the form component's user assistance presentation.",
+      "displayName": "User Assistance Density",
+      "help": "#userAssistanceDensity",
+      "propertyEditorValues": {
+        "reflow": {
+          "description": "Messages, help, hints, and required are all shown inline under the field with no reserved space.",
+          "displayName": "Reflow"
+        },
+        "efficient": {
+          "description": "Messages, help, hints, and required are all shown inline under the field with reserved space.",
+          "displayName": "Efficient"
+        }
+      },
+      "enumValues": [
+        "reflow",
+        "efficient"
+      ],
+      "binding": {
+        "consume": {
+          "name": "containerUserAssistanceDensity"
+        }
+      },
+      "value": "reflow"
+    },
+    "value": {
+      "type": "any",
+      "description": "The value of the component.",
+      "displayName": "Value",
+      "help": "#value",
+      "writeback": true,
+      "value": null
+    },
+    "valueItem": {
+      "type": "object|null",
+      "description": "The current value of the element and its associated data.",
+      "displayName": "Value Item",
+      "help": "#valueItem",
+      "properties": {
+        "data": {
+          "type": "any"
+        },
+        "key": {
+          "type": "any"
+        },
+        "metadata": {
+          "type": "object",
+          "properties": {
+            "indexFromParent": {
+              "type": "number"
+            },
+            "isLeaf": {
+              "type": "boolean"
+            },
+            "key": {
+              "type": "any"
+            },
+            "message": {
+              "type": "object",
+              "properties": {
+                "detail": {
+                  "type": "string"
+                },
+                "severity": {
+                  "type": "number|string",
+                  "enumValues": [
+                    "error",
+                    "confirmation",
+                    "info",
+                    "warning",
+                    "fatal"
+                  ]
+                },
+                "summary": {
+                  "type": "string"
+                }
+              }
+            },
+            "parentKey": {
+              "type": "any"
+            },
+            "suggestion": {
+              "type": "object"
+            },
+            "treeDepth": {
+              "type": "number"
+            }
+          }
+        }
+      },
+      "writeback": true,
+      "value": null
+    },
+    "virtualKeyboard": {
+      "type": "string",
+      "description": "The type of virtual keyboard to display for entering a value on mobile browsers",
+      "displayName": "Virtual Keyboard",
+      "help": "#virtualKeyboard",
+      "propertyEditorValues": {
+        "number": {
+          "description": "Use a mobile virtual keyboard for entering numbers. Note that on Android and Windows Mobile, the 'number' keyboard does not contain the minus sign. This value should not be used on fields that accept negative values.",
+          "displayName": "Number"
+        },
+        "auto": {
+          "description": "The component will determine the best mobile virtual keyboard to use (default, if unspecified).",
+          "displayName": "Auto"
+        },
+        "email": {
+          "description": "Use a mobile virtual keyboard for entering email addresses.",
+          "displayName": "Email"
+        },
+        "search": {
+          "description": "Use a mobile virtual keyboard for entering search terms.",
+          "displayName": "Search"
+        },
+        "tel": {
+          "description": "Use a mobile virtual keyboard for entering telephone numbers.",
+          "displayName": "Tel"
+        },
+        "text": {
+          "description": "Use a mobile virtual keyboard for entering text.",
+          "displayName": "Text"
+        },
+        "url": {
+          "description": "Use a mobile virtual keyboard for URL entry.",
+          "displayName": "URL"
+        }
+      },
+      "enumValues": [
+        "number",
+        "text",
+        "auto",
+        "search",
+        "email",
+        "tel",
+        "url"
+      ],
+      "value": "auto"
+    },
+    "valid": {
+      "type": "string",
+      "description": "Specifies how the valid state of the component",
+      "displayName": "Valid",
+      "help": "#valid",
+      "propertyEditorValues": {
+        "valid": {
+          "description": "The component is valid",
+          "displayName": "Valid"
+        },
+        "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"
+        },
+        "invalidHidden": {
+          "description": "The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity 'error'.",
+          "displayName": "Invalid Hidden"
+        },
+        "invalidShown": {
+          "description": "The component has invalid messages showing. An invalid message is one with severity 'error'.",
+          "displayName": "Invalid Shown"
+        }
+      },
+      "enumValues": [
+        "valid",
+        "pending",
+        "invalidHidden",
+        "invalidShown"
+      ],
+      "readOnly": true,
+      "writeback": true
+    }
+  },
+  "events": {
+    "ojValueAction": {
+      "description": "Event triggered when a value is submitted by the user, even if the value is the same as the previous value.",
+      "displayName": "onOjValueAction",
+      "help": "#event:valueAction",
+      "detail": {
+        "itemContext": {
+          "type": "object|null"
+        },
+        "previousValue": {
+          "type": "any"
+        },
+        "value": {
+          "type": "any"
+        }
+      }
+    }
+  },
+  "methods": {
+    "reset": {
+      "return": "any"
+    },
+    "showMessages": {
+      "return": "any"
+    },
+    "validate": {
+      "return": "Promise"
+    },
+    "blur": {
+      "return": "any"
+    },
+    "focus": {
+      "return": "any"
+    },
+    "setProperty": {
+      "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
+      "help": "#setProperty",
+      "params": [
+        {
+          "name": "property",
+          "description": "The property name to set. Supports dot notation for subproperty access.",
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "description": "The new value to set the property to.",
+          "type": "any"
+        }
+      ],
+      "return": "void"
+    },
+    "getProperty": {
+      "description": "Retrieves the value of a property or a subproperty.",
+      "help": "#getProperty",
+      "params": [
+        {
+          "name": "property",
+          "description": "The property name to get. Supports dot notation for subproperty access.",
+          "type": "string"
+        }
+      ],
+      "return": "any"
+    },
+    "setProperties": {
+      "description": "Performs a batch set of properties.",
+      "help": "#setProperties",
+      "params": [
+        {
+          "name": "properties",
+          "description": "An object containing the property and value pairs to set.",
+          "type": "object"
+        }
+      ],
+      "return": "void"
+    }
+  }
+}

package/oj-c/select-single/index.js

@@ -0,0 +1,6 @@
+define(["require", "exports", "./select-single"], function (require, exports, select_single_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SelectSingle = void 0;
+    Object.defineProperty(exports, "SelectSingle", { enumerable: true, get: function () { return select_single_1.SelectSingle; } });
+});

package/oj-c/select-single/select-single-styles.css

@@ -0,0 +1,22 @@
+/* This file is where css selectors for the component go.
+   There will be hard coded properties and properties controlled by variables, for example
+
+   oj-c-select-single .oj-c-select-single-value-text {
+   color: var(--oj-c-select-single-value-text-color);
+   display: inline-block;
+	 }
+*/
+
+oj-c-select-single:not(.oj-complete){
+  visibility: hidden;
+}
+
+oj-c-select-single{
+	display: inline-block;
+  max-width: 100%;
+  width: 100%;
+}
+
+oj-c-select-single[hidden] {
+  display: none;
+}

package/oj-c/select-single/select-single.js

@@ -0,0 +1,108 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["require", "exports", "preact/jsx-runtime", '@oracle/oraclejet-preact/translationBundle', "@oracle/oraclejet-preact/hooks/UNSAFE_useFormContext", "@oracle/oraclejet-preact/hooks/UNSAFE_useFormVariantContext", "@oracle/oraclejet-preact/hooks/UNSAFE_useTabbableMode", "@oracle/oraclejet-preact/UNSAFE_SelectSingle", "oj-c/editable-value/UNSAFE_useAssistiveText/useAssistiveText", "ojs/ojcontext", "ojs/ojvcomponent", "ojs/ojvcomponent-binding", "preact", "preact/compat", "preact/hooks", "./useSelectSinglePreact", "css!./select-single-styles.css"], function (require, exports, jsx_runtime_1, translationBundle_1, UNSAFE_useFormContext_1, UNSAFE_useFormVariantContext_1, UNSAFE_useTabbableMode_1, UNSAFE_SelectSingle_1, useAssistiveText_1, ojcontext_1, ojvcomponent_1, ojvcomponent_binding_1, preact_1, compat_1, hooks_1, useSelectSinglePreact_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SelectSingle = void 0;
+    translationBundle_1 = __importDefault(translationBundle_1);
+    ojcontext_1 = __importDefault(ojcontext_1);
+    const FunctionalSelectSingle = (0, compat_1.forwardRef)((props, ref) => {
+        const { busyContextRef, displayOptions, help, helpHints } = props;
+        const selectSingleRef = (0, hooks_1.useRef)();
+        const addBusyState = (0, hooks_1.useCallback)((desc) => {
+            var _a;
+            return (_a = busyContextRef.current) === null || _a === void 0 ? void 0 : _a.addBusyState({
+                description: `oj-c-select-single id=${props.id}: ${desc}`
+            });
+        }, []);
+        const { selectSingleProps, methods } = (0, useSelectSinglePreact_1.useSelectSinglePreact)(props, addBusyState);
+        (0, hooks_1.useImperativeHandle)(ref, () => (Object.assign({ blur: () => { var _a; return (_a = selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.blur(); }, focus: () => { var _a; return (_a = selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.focus(); } }, methods)), [methods]);
+        const assistiveTextProps = (0, useAssistiveText_1.useAssistiveText)({
+            displayOptions,
+            help,
+            helpHints
+        });
+        const variant = (0, UNSAFE_useFormVariantContext_1.useFormVariantContext)();
+        return ((0, jsx_runtime_1.jsx)(UNSAFE_SelectSingle_1.SelectSingle, Object.assign({ ref: selectSingleRef }, assistiveTextProps, selectSingleProps, { variant: variant })));
+    });
+    let SelectSingle = class SelectSingle extends preact_1.Component {
+        constructor() {
+            super(...arguments);
+            this.busyContextRef = (0, preact_1.createRef)();
+            this.selectSingleRef = (0, preact_1.createRef)();
+            this.rootRef = (0, preact_1.createRef)();
+        }
+        componentDidMount() {
+            this.busyContextRef.current = ojcontext_1.default.getContext(this.rootRef.current).getBusyContext();
+        }
+        render(props) {
+            const containerProps = {
+                isFormLayout: props.containerReadonly !== undefined,
+                isReadonly: props.containerReadonly,
+                labelWrapping: props.labelWrapping
+            };
+            return ((0, jsx_runtime_1.jsx)(ojvcomponent_1.Root, Object.assign({ id: props.id, ref: this.rootRef }, { children: (0, jsx_runtime_1.jsx)(UNSAFE_useFormContext_1.FormContext.Provider, Object.assign({ value: containerProps }, { children: (0, jsx_runtime_1.jsx)(FunctionalSelectSingle, Object.assign({ busyContextRef: this.busyContextRef, ref: this.selectSingleRef }, props)) })) })));
+        }
+        componentWillUnmount() {
+            this.busyContextRef.current = null;
+        }
+        reset() {
+            var _a;
+            (_a = this.selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.reset();
+        }
+        showMessages() {
+            var _a;
+            (_a = this.selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.showMessages();
+        }
+        validate() {
+            var _a;
+            return (_a = this.selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.validate();
+        }
+        blur() {
+            var _a;
+            (_a = this.selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.blur();
+        }
+        focus() {
+            var _a;
+            (_a = this.selectSingleRef.current) === null || _a === void 0 ? void 0 : _a.focus();
+        }
+    };
+    SelectSingle.defaultProps = {
+        data: null,
+        disabled: false,
+        displayOptions: {
+            messages: 'display'
+        },
+        help: {
+            instruction: ''
+        },
+        helpHints: {
+            definition: '',
+            source: '',
+            sourceText: undefined
+        },
+        messagesCustom: [],
+        readonly: false,
+        required: false,
+        userAssistanceDensity: 'reflow',
+        value: null,
+        valueItem: null,
+        virtualKeyboard: 'auto'
+    };
+    SelectSingle._metadata = { "properties": { "containerReadonly": { "type": "boolean", "binding": { "consume": { "name": "containerReadonly" } } }, "data": { "type": "object|null" }, "disabled": { "type": "boolean" }, "displayOptions": { "type": "object", "properties": { "messages": { "type": "string", "enumValues": ["display", "none"] } } }, "help": { "type": "object", "properties": { "instruction": { "type": "string" } } }, "helpHints": { "type": "object", "properties": { "definition": { "type": "string" }, "source": { "type": "string" }, "sourceText": { "type": "string" } } }, "itemText": { "type": "string|number|function" }, "labelEdge": { "type": "string", "enumValues": ["start", "none", "top", "inside"], "binding": { "consume": { "name": "containerLabelEdge" } } }, "labelHint": { "type": "string" }, "labelStartWidth": { "type": "string", "binding": { "consume": { "name": "labelWidth" } } }, "labelWrapping": { "type": "string", "enumValues": ["wrap", "truncate"], "binding": { "consume": { "name": "labelWrapping" } } }, "messagesCustom": { "type": "Array<object>", "writeback": true }, "placeholder": { "type": "string" }, "readonly": { "type": "boolean", "binding": { "consume": { "name": "containerReadonly" } } }, "required": { "type": "boolean" }, "requiredMessageDetail": { "type": "string" }, "textAlign": { "type": "string", "enumValues": ["start", "right", "end"] }, "userAssistanceDensity": { "type": "string", "enumValues": ["reflow", "efficient"], "binding": { "consume": { "name": "containerUserAssistanceDensity" } } }, "value": { "type": "any", "writeback": true }, "valueItem": { "type": "object|null", "properties": { "data": { "type": "any" }, "key": { "type": "any" }, "metadata": { "type": "object", "properties": { "indexFromParent": { "type": "number" }, "isLeaf": { "type": "boolean" }, "key": { "type": "any" }, "message": { "type": "object", "properties": { "detail": { "type": "string" }, "severity": { "type": "number|string", "enumValues": ["error", "confirmation", "info", "warning", "fatal"] }, "summary": { "type": "string" } } }, "parentKey": { "type": "any" }, "suggestion": { "type": "object" }, "treeDepth": { "type": "number" } } } }, "writeback": true }, "virtualKeyboard": { "type": "string", "enumValues": ["number", "text", "auto", "search", "email", "tel", "url"] }, "valid": { "type": "string", "enumValues": ["valid", "pending", "invalidHidden", "invalidShown"], "readOnly": true, "writeback": true } }, "events": { "ojValueAction": {} }, "extension": { "_WRITEBACK_PROPS": ["messagesCustom", "valid", "value", "valueItem"], "_READ_ONLY_PROPS": ["valid"], "_OBSERVED_GLOBAL_PROPS": ["aria-describedby", "id"] }, "methods": { "reset": {}, "showMessages": {}, "validate": {}, "blur": {}, "focus": {} } };
+    SelectSingle._translationBundleMap = {
+        '@oracle/oraclejet-preact': translationBundle_1.default
+    };
+    SelectSingle._consumedContexts = [UNSAFE_useFormVariantContext_1.FormVariantContext, UNSAFE_useTabbableMode_1.TabbableModeContext];
+    SelectSingle = __decorate([
+        (0, ojvcomponent_1.customElement)('oj-c-select-single')
+    ], SelectSingle);
+    exports.SelectSingle = SelectSingle;
+});