@fluentui/react-utilities 0.0.0-nightly-20230317-1454.1 → 0.0.0-nightly-20230321-0440.1

package/lib-commonjs/utils/properties.js

@@ -1,338 +1,234 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    baseElementEvents: ()=>baseElementEvents,
-    baseElementProperties: ()=>baseElementProperties,
-    microdataProperties: ()=>microdataProperties,
-    htmlElementProperties: ()=>htmlElementProperties,
-    labelProperties: ()=>labelProperties,
-    audioProperties: ()=>audioProperties,
-    videoProperties: ()=>videoProperties,
-    olProperties: ()=>olProperties,
-    liProperties: ()=>liProperties,
-    anchorProperties: ()=>anchorProperties,
-    timeProperties: ()=>timeProperties,
-    buttonProperties: ()=>buttonProperties,
-    inputProperties: ()=>inputProperties,
-    textAreaProperties: ()=>textAreaProperties,
-    selectProperties: ()=>selectProperties,
-    optionProperties: ()=>optionProperties,
-    tableProperties: ()=>tableProperties,
-    trProperties: ()=>trProperties,
-    thProperties: ()=>thProperties,
-    tdProperties: ()=>tdProperties,
-    colGroupProperties: ()=>colGroupProperties,
-    colProperties: ()=>colProperties,
-    fieldsetProperties: ()=>fieldsetProperties,
-    formProperties: ()=>formProperties,
-    iframeProperties: ()=>iframeProperties,
-    imgProperties: ()=>imgProperties,
-    dialogProperties: ()=>dialogProperties,
-    divProperties: ()=>divProperties,
-    getNativeProps: ()=>getNativeProps
+  value: true
 });
-const toObjectMap = (...items)=>{
-    const result = {};
-    for (const item of items){
-        const keys = Array.isArray(item) ? item : Object.keys(item);
-        for (const key of keys){
-            result[key] = 1;
-        }
+exports.getNativeProps = exports.divProperties = exports.dialogProperties = exports.imgProperties = exports.iframeProperties = exports.formProperties = exports.fieldsetProperties = exports.colProperties = exports.colGroupProperties = exports.tdProperties = exports.thProperties = exports.trProperties = exports.tableProperties = exports.optionProperties = exports.selectProperties = exports.textAreaProperties = exports.inputProperties = exports.buttonProperties = exports.timeProperties = exports.anchorProperties = exports.liProperties = exports.olProperties = exports.videoProperties = exports.audioProperties = exports.labelProperties = exports.htmlElementProperties = exports.microdataProperties = exports.baseElementProperties = exports.baseElementEvents = void 0;
+const toObjectMap = (...items) => {
+  const result = {};
+  for (const item of items) {
+    const keys = Array.isArray(item) ? item : Object.keys(item);
+    for (const key of keys) {
+      result[key] = 1;
     }
-    return result;
+  }
+  return result;
 };
-const baseElementEvents = /*#__PURE__*/ toObjectMap([
-    "onAuxClick",
-    "onCopy",
-    "onCut",
-    "onPaste",
-    "onCompositionEnd",
-    "onCompositionStart",
-    "onCompositionUpdate",
-    "onFocus",
-    "onFocusCapture",
-    "onBlur",
-    "onBlurCapture",
-    "onChange",
-    "onInput",
-    "onSubmit",
-    "onLoad",
-    "onError",
-    "onKeyDown",
-    "onKeyDownCapture",
-    "onKeyPress",
-    "onKeyUp",
-    "onAbort",
-    "onCanPlay",
-    "onCanPlayThrough",
-    "onDurationChange",
-    "onEmptied",
-    "onEncrypted",
-    "onEnded",
-    "onLoadedData",
-    "onLoadedMetadata",
-    "onLoadStart",
-    "onPause",
-    "onPlay",
-    "onPlaying",
-    "onProgress",
-    "onRateChange",
-    "onSeeked",
-    "onSeeking",
-    "onStalled",
-    "onSuspend",
-    "onTimeUpdate",
-    "onVolumeChange",
-    "onWaiting",
-    "onClick",
-    "onClickCapture",
-    "onContextMenu",
-    "onDoubleClick",
-    "onDrag",
-    "onDragEnd",
-    "onDragEnter",
-    "onDragExit",
-    "onDragLeave",
-    "onDragOver",
-    "onDragStart",
-    "onDrop",
-    "onMouseDown",
-    "onMouseDownCapture",
-    "onMouseEnter",
-    "onMouseLeave",
-    "onMouseMove",
-    "onMouseOut",
-    "onMouseOver",
-    "onMouseUp",
-    "onMouseUpCapture",
-    "onSelect",
-    "onTouchCancel",
-    "onTouchEnd",
-    "onTouchMove",
-    "onTouchStart",
-    "onScroll",
-    "onWheel",
-    "onPointerCancel",
-    "onPointerDown",
-    "onPointerEnter",
-    "onPointerLeave",
-    "onPointerMove",
-    "onPointerOut",
-    "onPointerOver",
-    "onPointerUp",
-    "onGotPointerCapture",
-    "onLostPointerCapture"
-]);
-const baseElementProperties = /*#__PURE__*/ toObjectMap([
-    "accessKey",
-    "children",
-    "className",
-    "contentEditable",
-    "dir",
-    "draggable",
-    "hidden",
-    "htmlFor",
-    "id",
-    "lang",
-    "ref",
-    "role",
-    "style",
-    "tabIndex",
-    "title",
-    "translate",
-    "spellCheck",
-    "name"
-]);
-const microdataProperties = /*#__PURE__*/ toObjectMap([
-    "itemID",
-    "itemProp",
-    "itemRef",
-    "itemScope",
-    "itemType"
-]);
-const htmlElementProperties = /*#__PURE__*/ toObjectMap(baseElementProperties, baseElementEvents, microdataProperties);
-const labelProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "form"
-]);
-const audioProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "height",
-    "loop",
-    "muted",
-    "preload",
-    "src",
-    "width"
-]);
-const videoProperties = /*#__PURE__*/ toObjectMap(audioProperties, [
-    "poster"
-]);
-const olProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "start"
-]);
-const liProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "value"
-]);
-const anchorProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "download",
-    "href",
-    "hrefLang",
-    "media",
-    "rel",
-    "target",
-    "type"
-]);
-const timeProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "dateTime"
-]);
-const buttonProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "autoFocus",
-    "disabled",
-    "form",
-    "formAction",
-    "formEncType",
-    "formMethod",
-    "formNoValidate",
-    "formTarget",
-    "type",
-    "value"
-]);
-const inputProperties = /*#__PURE__*/ toObjectMap(buttonProperties, [
-    "accept",
-    "alt",
-    "autoCapitalize",
-    "autoComplete",
-    "checked",
-    "dirname",
-    "form",
-    "height",
-    "inputMode",
-    "list",
-    "max",
-    "maxLength",
-    "min",
-    "multiple",
-    "pattern",
-    "placeholder",
-    "readOnly",
-    "required",
-    "src",
-    "step",
-    "size",
-    "type",
-    "value",
-    "width"
-]);
-const textAreaProperties = /*#__PURE__*/ toObjectMap(buttonProperties, [
-    "autoCapitalize",
-    "cols",
-    "dirname",
-    "form",
-    "maxLength",
-    "placeholder",
-    "readOnly",
-    "required",
-    "rows",
-    "wrap"
-]);
-const selectProperties = /*#__PURE__*/ toObjectMap(buttonProperties, [
-    "form",
-    "multiple",
-    "required"
-]);
-const optionProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "selected",
-    "value"
-]);
-const tableProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "cellPadding",
-    "cellSpacing"
-]);
-const trProperties = htmlElementProperties;
-const thProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "colSpan",
-    "rowSpan",
-    "scope"
-]);
-const tdProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "colSpan",
-    "headers",
-    "rowSpan",
-    "scope"
-]);
-const colGroupProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "span"
-]);
-const colProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "span"
-]);
-const fieldsetProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "disabled",
-    "form"
-]);
-const formProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "acceptCharset",
-    "action",
-    "encType",
-    "encType",
-    "method",
-    "noValidate",
-    "target"
-]);
-const iframeProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "allow",
-    "allowFullScreen",
-    "allowPaymentRequest",
-    "allowTransparency",
-    "csp",
-    "height",
-    "importance",
-    "referrerPolicy",
-    "sandbox",
-    "src",
-    "srcDoc",
-    "width"
+/**
+ * An array of events that are allowed on every html element type.
+ *
+ * @public
+ */
+exports.baseElementEvents = /*#__PURE__*/toObjectMap(['onAuxClick', 'onCopy', 'onCut', 'onPaste', 'onCompositionEnd', 'onCompositionStart', 'onCompositionUpdate', 'onFocus', 'onFocusCapture', 'onBlur', 'onBlurCapture', 'onChange', 'onInput', 'onSubmit', 'onLoad', 'onError', 'onKeyDown', 'onKeyDownCapture', 'onKeyPress', 'onKeyUp', 'onAbort', 'onCanPlay', 'onCanPlayThrough', 'onDurationChange', 'onEmptied', 'onEncrypted', 'onEnded', 'onLoadedData', 'onLoadedMetadata', 'onLoadStart', 'onPause', 'onPlay', 'onPlaying', 'onProgress', 'onRateChange', 'onSeeked', 'onSeeking', 'onStalled', 'onSuspend', 'onTimeUpdate', 'onVolumeChange', 'onWaiting', 'onClick', 'onClickCapture', 'onContextMenu', 'onDoubleClick', 'onDrag', 'onDragEnd', 'onDragEnter', 'onDragExit', 'onDragLeave', 'onDragOver', 'onDragStart', 'onDrop', 'onMouseDown', 'onMouseDownCapture', 'onMouseEnter', 'onMouseLeave', 'onMouseMove', 'onMouseOut', 'onMouseOver', 'onMouseUp', 'onMouseUpCapture', 'onSelect', 'onTouchCancel', 'onTouchEnd', 'onTouchMove', 'onTouchStart', 'onScroll', 'onWheel', 'onPointerCancel', 'onPointerDown', 'onPointerEnter', 'onPointerLeave', 'onPointerMove', 'onPointerOut', 'onPointerOver', 'onPointerUp', 'onGotPointerCapture', 'onLostPointerCapture']);
+/**
+ * An array of element attributes which are allowed on every html element type.
+ *
+ * @public
+ */
+exports.baseElementProperties = /*#__PURE__*/toObjectMap(['accessKey', 'children', 'className', 'contentEditable', 'dir', 'draggable', 'hidden', 'htmlFor', 'id', 'lang', 'ref', 'role', 'style', 'tabIndex', 'title', 'translate', 'spellCheck', 'name' // global
+]);
+/**
+ * An array of microdata attributes that are allowed on every html element type.
+ *
+ * @public
+ */
+exports.microdataProperties = /*#__PURE__*/toObjectMap(['itemID', 'itemProp', 'itemRef', 'itemScope', 'itemType' // global
+]);
+/**
+ * An array of HTML element properties and events.
+ *
+ * @public
+ */
+exports.htmlElementProperties = /*#__PURE__*/toObjectMap(exports.baseElementProperties, exports.baseElementEvents, exports.microdataProperties);
+/**
+ * An array of LABEL tag properties and events.
+ *
+ * @public
+ */
+exports.labelProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['form' // button, fieldset, input, label, meter, object, output, select, textarea
+]);
+/**
+ * An array of AUDIO tag properties and events.
+
+ * @public
+ */
+exports.audioProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['height', 'loop', 'muted', 'preload', 'src', 'width' // canvas, embed, iframe, img, input, object, video
+]);
+/**
+ * An array of VIDEO tag properties and events.
+ *
+ * @public
+ */
+exports.videoProperties = /*#__PURE__*/toObjectMap(exports.audioProperties, ['poster' // video
+]);
+/**
+ * An array of OL tag properties and events.
+ *
+ * @public
+ */
+exports.olProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['start' // ol
+]);
+/**
+ * An array of LI tag properties and events.
+ *
+ * @public
+ */
+exports.liProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['value' // button, input, li, option, meter, progress, param
+]);
+/**
+ * An array of A tag properties and events.
+ *
+ * @public
+ */
+exports.anchorProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['download', 'href', 'hrefLang', 'media', 'rel', 'target', 'type' // a, button, input, link, menu, object, script, source, style
+]);
+/**
+ * An array of TIME tag properties and events.
+ *
+ * @public
+ */
+exports.timeProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['dateTime' // time
+]);
+/**
+ * An array of BUTTON tag properties and events.
+ *
+ * @public
+ */
+exports.buttonProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['autoFocus', 'disabled', 'form', 'formAction', 'formEncType', 'formMethod', 'formNoValidate', 'formTarget', 'type', 'value' // button, input, li, option, meter, progress, param,
+]);
+/**
+ * An array of INPUT tag properties and events.
+ *
+ * @public
+ */
+exports.inputProperties = /*#__PURE__*/toObjectMap(exports.buttonProperties, ['accept', 'alt', 'autoCapitalize', 'autoComplete', 'checked', 'dirname', 'form', 'height', 'inputMode', 'list', 'max', 'maxLength', 'min', 'multiple', 'pattern', 'placeholder', 'readOnly', 'required', 'src', 'step', 'size', 'type', 'value', 'width' // canvas, embed, iframe, img, input, object, video
+]);
+/**
+ * An array of TEXTAREA tag properties and events.
+ *
+ * @public
+ */
+exports.textAreaProperties = /*#__PURE__*/toObjectMap(exports.buttonProperties, ['autoCapitalize', 'cols', 'dirname', 'form', 'maxLength', 'placeholder', 'readOnly', 'required', 'rows', 'wrap' // textarea
+]);
+/**
+ * An array of SELECT tag properties and events.
+ *
+ * @public
+ */
+exports.selectProperties = /*#__PURE__*/toObjectMap(exports.buttonProperties, ['form', 'multiple', 'required' // input, select, textarea
 ]);
-const imgProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "alt",
-    "crossOrigin",
-    "height",
-    "src",
-    "srcSet",
-    "useMap",
-    "width"
+
+exports.optionProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['selected', 'value' // button, input, li, option, meter, progress, param
+]);
+/**
+ * An array of TABLE tag properties and events.
+ *
+ * @public
+ */
+exports.tableProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['cellPadding', 'cellSpacing' // table
+]);
+/**
+ * An array of TR tag properties and events.
+ *
+ * @public
+ */
+exports.trProperties = exports.htmlElementProperties;
+/**
+ * An array of TH tag properties and events.
+ *
+ * @public
+ */
+exports.thProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['colSpan', 'rowSpan', 'scope' // th
+]);
+/**
+ * An array of TD tag properties and events.
+ *
+ * @public
+ */
+exports.tdProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['colSpan', 'headers', 'rowSpan', 'scope' // th
 ]);
-const dialogProperties = /*#__PURE__*/ toObjectMap(htmlElementProperties, [
-    "open",
-    "onCancel",
-    "onClose"
+
+exports.colGroupProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['span' // col, colgroup
 ]);
-const divProperties = htmlElementProperties;
-function getNativeProps(// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+exports.colProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['span' // col, colgroup
+]);
+/**
+ * An array of FIELDSET tag properties and events.
+ *
+ * @public
+ */
+exports.fieldsetProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['disabled', 'form' // button, fieldset, input, label, meter, object, output, select, textarea
+]);
+/**
+ * An array of FORM tag properties and events.
+ *
+ * @public
+ */
+exports.formProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['acceptCharset', 'action', 'encType', 'encType', 'method', 'noValidate', 'target' // form
+]);
+/**
+ * An array of IFRAME tag properties and events.
+ *
+ * @public
+ */
+exports.iframeProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['allow', 'allowFullScreen', 'allowPaymentRequest', 'allowTransparency', 'csp', 'height', 'importance', 'referrerPolicy', 'sandbox', 'src', 'srcDoc', 'width' // canvas, embed, iframe, img, input, object, video,
+]);
+/**
+ * An array of IMAGE tag properties and events.
+ *
+ * @public
+ */
+exports.imgProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['alt', 'crossOrigin', 'height', 'src', 'srcSet', 'useMap', 'width' // canvas, embed, iframe, img, input, object, video
+]);
+/**
+ * An array of DIALOG tag properties and events.
+ *
+ * @public
+ */
+exports.dialogProperties = /*#__PURE__*/toObjectMap(exports.htmlElementProperties, ['open', 'onCancel', 'onClose']);
+/**
+ * An array of DIV tag properties and events.
+ *
+ * @public
+ */
+exports.divProperties = exports.htmlElementProperties;
+/**
+ * Gets native supported props for an html element provided the allowance set. Use one of the property
+ * sets defined (divProperties, buttonPropertes, etc) to filter out supported properties from a given
+ * props set. Note that all data- and aria- prefixed attributes will be allowed.
+ * NOTE: getNativeProps should always be applied first when adding props to a react component. The
+ * non-native props should be applied second. This will prevent getNativeProps from overriding your custom props.
+ * For example, if props passed to getNativeProps has an onClick function and getNativeProps is added to
+ * the component after an onClick function is added, then the getNativeProps onClick will override it.
+ *
+ * @public
+ * @param props - The unfiltered input props
+ * @param allowedPropNames - The array or record of allowed prop names.
+ * @param excludedPropNames
+ * @returns The filtered props
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getNativeProps(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 props, allowedPropNames, excludedPropNames) {
-    // It'd be great to properly type this while allowing 'aria-` and 'data-' attributes like TypeScript does for
-    // JSX attributes, but that ability is hardcoded into the TS compiler with no analog in TypeScript typings.
-    // Then we'd be able to enforce props extends native props (including aria- and data- attributes), and then
-    // return native props.
-    // We should be able to do this once this PR is merged: https://github.com/microsoft/TypeScript/pull/26797
-    const isArray = Array.isArray(allowedPropNames);
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const result = {};
-    const keys = Object.keys(props);
-    for (const key of keys){
-        const isNativeProp = !isArray && allowedPropNames[key] || isArray && allowedPropNames.indexOf(key) >= 0 || key.indexOf("data-") === 0 || key.indexOf("aria-") === 0;
-        if (isNativeProp && (!excludedPropNames || excludedPropNames?.indexOf(key) === -1)) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            result[key] = props[key];
-        }
+  // It'd be great to properly type this while allowing 'aria-` and 'data-' attributes like TypeScript does for
+  // JSX attributes, but that ability is hardcoded into the TS compiler with no analog in TypeScript typings.
+  // Then we'd be able to enforce props extends native props (including aria- and data- attributes), and then
+  // return native props.
+  // We should be able to do this once this PR is merged: https://github.com/microsoft/TypeScript/pull/26797
+  const isArray = Array.isArray(allowedPropNames);
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const result = {};
+  const keys = Object.keys(props);
+  for (const key of keys) {
+    const isNativeProp = !isArray && allowedPropNames[key] || isArray && allowedPropNames.indexOf(key) >= 0 || key.indexOf('data-') === 0 || key.indexOf('aria-') === 0;
+    if (isNativeProp && (!excludedPropNames || (excludedPropNames === null || excludedPropNames === void 0 ? void 0 : excludedPropNames.indexOf(key)) === -1)) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      result[key] = props[key];
     }
-    return result;
-} //# sourceMappingURL=properties.js.map
-
+  }
+  return result;
+}
+exports.getNativeProps = getNativeProps;
 //# sourceMappingURL=properties.js.map