@rc-component/select 1.0.0

package/lib/utils/warningPropsUtil.js

@@ -0,0 +1,129 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.warningNullOptions = warningNullOptions;
+var _toArray = _interopRequireDefault(require("@rc-component/util/lib/Children/toArray"));
+var _warning = _interopRequireWildcard(require("@rc-component/util/lib/warning"));
+var React = _interopRequireWildcard(require("react"));
+var _BaseSelect = require("../BaseSelect");
+var _commonUtil = require("./commonUtil");
+var _legacyUtil = require("./legacyUtil");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function warningProps(props) {
+  const {
+    mode,
+    options,
+    children,
+    backfill,
+    allowClear,
+    placeholder,
+    getInputElement,
+    showSearch,
+    onSearch,
+    defaultOpen,
+    autoFocus,
+    labelInValue,
+    value,
+    optionLabelProp
+  } = props;
+  const multiple = (0, _BaseSelect.isMultiple)(mode);
+  const mergedShowSearch = showSearch !== undefined ? showSearch : multiple || mode === 'combobox';
+  const mergedOptions = options || (0, _legacyUtil.convertChildrenToData)(children);
+
+  // `tags` should not set option as disabled
+  (0, _warning.default)(mode !== 'tags' || mergedOptions.every(opt => !opt.disabled), 'Please avoid setting option to disabled in tags mode since user can always type text as tag.');
+
+  // `combobox` & `tags` should option be `string` type
+  if (mode === 'tags' || mode === 'combobox') {
+    const hasNumberValue = mergedOptions.some(item => {
+      if (item.options) {
+        return item.options.some(opt => typeof ('value' in opt ? opt.value : opt.key) === 'number');
+      }
+      return typeof ('value' in item ? item.value : item.key) === 'number';
+    });
+    (0, _warning.default)(!hasNumberValue, '`value` of Option should not use number type when `mode` is `tags` or `combobox`.');
+  }
+
+  // `combobox` should not use `optionLabelProp`
+  (0, _warning.default)(mode !== 'combobox' || !optionLabelProp, '`combobox` mode not support `optionLabelProp`. Please set `value` on Option directly.');
+
+  // Only `combobox` support `backfill`
+  (0, _warning.default)(mode === 'combobox' || !backfill, '`backfill` only works with `combobox` mode.');
+
+  // Only `combobox` support `getInputElement`
+  (0, _warning.default)(mode === 'combobox' || !getInputElement, '`getInputElement` only work with `combobox` mode.');
+
+  // Customize `getInputElement` should not use `allowClear` & `placeholder`
+  (0, _warning.noteOnce)(mode !== 'combobox' || !getInputElement || !allowClear || !placeholder, 'Customize `getInputElement` should customize clear and placeholder logic instead of configuring `allowClear` and `placeholder`.');
+
+  // `onSearch` should use in `combobox` or `showSearch`
+  if (onSearch && !mergedShowSearch && mode !== 'combobox' && mode !== 'tags') {
+    (0, _warning.default)(false, '`onSearch` should work with `showSearch` instead of use alone.');
+  }
+  (0, _warning.noteOnce)(!defaultOpen || autoFocus, '`defaultOpen` makes Select open without focus which means it will not close by click outside. You can set `autoFocus` if needed.');
+  if (value !== undefined && value !== null) {
+    const values = (0, _commonUtil.toArray)(value);
+    (0, _warning.default)(!labelInValue || values.every(val => typeof val === 'object' && ('key' in val || 'value' in val)), '`value` should in shape of `{ value: string | number, label?: ReactNode }` when you set `labelInValue` to `true`');
+    (0, _warning.default)(!multiple || Array.isArray(value), '`value` should be array when `mode` is `multiple` or `tags`');
+  }
+
+  // Syntactic sugar should use correct children type
+  if (children) {
+    let invalidateChildType = null;
+    (0, _toArray.default)(children).some(node => {
+      if (! /*#__PURE__*/React.isValidElement(node) || !node.type) {
+        return false;
+      }
+      const {
+        type
+      } = node;
+      if (type.isSelectOption) {
+        return false;
+      }
+      if (type.isSelectOptGroup) {
+        const allChildrenValid = (0, _toArray.default)(node.props.children).every(subNode => {
+          if (! /*#__PURE__*/React.isValidElement(subNode) || !node.type || subNode.type.isSelectOption) {
+            return true;
+          }
+          invalidateChildType = subNode.type;
+          return false;
+        });
+        if (allChildrenValid) {
+          return false;
+        }
+        return true;
+      }
+      invalidateChildType = type;
+      return true;
+    });
+    if (invalidateChildType) {
+      (0, _warning.default)(false, `\`children\` should be \`Select.Option\` or \`Select.OptGroup\` instead of \`${invalidateChildType.displayName || invalidateChildType.name || invalidateChildType}\`.`);
+    }
+  }
+}
+
+// value in Select option should not be null
+// note: OptGroup has options too
+function warningNullOptions(options, fieldNames) {
+  if (options) {
+    const recursiveOptions = (optionsList, inGroup = false) => {
+      for (let i = 0; i < optionsList.length; i++) {
+        const option = optionsList[i];
+        if (option[fieldNames?.value] === null) {
+          (0, _warning.default)(false, '`value` in Select options should not be `null`.');
+          return true;
+        }
+        if (!inGroup && Array.isArray(option[fieldNames?.options]) && recursiveOptions(option[fieldNames?.options], true)) {
+          break;
+        }
+      }
+    };
+    recursiveOptions(options);
+  }
+}
+var _default = exports.default = warningProps;

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@rc-component/select",
+  "version": "1.0.0",
+  "description": "React Select",
+  "engines": {
+    "node": ">=8.x"
+  },
+  "keywords": [
+    "react",
+    "react-component",
+    "react-select",
+    "select"
+  ],
+  "main": "./lib/index",
+  "module": "./es/index",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "assets/*.css",
+    "assets/*.less",
+    "es",
+    "lib"
+  ],
+  "homepage": "http://github.com/react-component/select",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:react-component/select.git"
+  },
+  "bugs": {
+    "url": "http://github.com/react-component/select/issues"
+  },
+  "license": "MIT",
+  "scripts": {
+    "start": "dumi dev",
+    "build": "dumi build",
+    "prepare": "husky && dumi setup",
+    "compile": "father build && lessc assets/index.less assets/index.css",
+    "prepublishOnly": "npm run compile && rc-np",
+    "prettier": "prettier --write --ignore-unknown .",
+    "lint": "eslint src/ docs/ tests/ --ext .tsx,.ts,.jsx,.js",
+    "test": "rc-test",
+    "tsc": "tsc --noEmit",
+    "now-build": "npm run build"
+  },
+  "lint-staged": {
+    "*": "prettier --write --ignore-unknown"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
+  },
+  "dependencies": {
+    "@rc-component/trigger": "^3.0.0",
+    "@rc-component/motion": "^1.1.4",
+    "@rc-component/util": "^1.2.1",
+    "classnames": "2.x",
+    "rc-overflow": "^1.4.0",
+    "rc-virtual-list": "^3.5.2"
+  },
+  "devDependencies": {
+    "@rc-component/father-plugin": "^2.0.2",
+    "@rc-component/np": "^1.0.0",
+    "@testing-library/jest-dom": "^6.4.5",
+    "@testing-library/react": "^15.0.6",
+    "@types/jest": "^29.5.12",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "babel-jest": "^29.6.1",
+    "cross-env": "^7.0.0",
+    "dumi": "^2.2.13",
+    "eslint": "^8.55.0",
+    "eslint-plugin-jest": "^28.8.1",
+    "eslint-plugin-unicorn": "^56.0.0",
+    "father": "^4.0.0",
+    "husky": "^9.1.5",
+    "jsonp": "^0.2.1",
+    "less": "^4.2.0",
+    "lint-staged": "^15.2.9",
+    "prettier": "^3.1.1",
+    "querystring": "^0.2.1",
+    "rc-dialog": "^9.0.0",
+    "rc-test": "^7.0.9",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": "^5.2.2"
+  }
+}