@qsxy/element-plus-react 1.0.0-next.1 → 1.0.0-next.3

package/dist/hooks/useClassNames.d.ts

@@ -14,16 +14,94 @@ export type ClassNameM = {
     ebm: (sub: string, prefix: string, modifier: string, compName?: boolean) => string;
     is: (...classes: ClassValue[]) => string;
 };
+/**
+ * Add a prefix to all classNames.
+ *
+ * @param str prefix of className
+ * @returns { wb, merge, prefix }
+ *  - wb: A function of combining className and adding a prefix to each className.
+ *    At the same time, the default `classPrefix` is the first className.
+ *  - merge: A merge className function.
+ *  - prefix: Add a prefix to className
+ */
 declare function useClassNames(str: string, classPrefix?: string): {
+    /**
+     * 如果组件前缀是'button':
+     *
+     * wb('red', { active: true }) => 'el-button el-button-red el-button-active'
+     *
+     * wb('red', { active: true }, false) => 'el-button el-red el-active'
+     */
     wb: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * b('red', { active: true }) => 'el-button-red el-button-active'
+     *
+     * b('red', { active: true }, false) => 'el-red el-active'
+     */
     b: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * e('red', { active: true }) => 'el-button__red el-button__active'
+     *
+     * e('red', { active: true }, false) => 'r__red r__active'
+     */
     e: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * m('red', { active: true }) => 'el-button--red el-button--active'
+     *
+     * m('red', { active: true }, false) => 'el--red el--active'
+     */
     m: (...classes: ClassValue[]) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * be('red', 'active') => 'el-button-red__active'
+     *
+     * be('red', 'active', false) => 'el-red__active'
+     */
     be: (prefix: string, sub: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * em( 'color", 'active') => 'el-button__color--active'
+     *
+     * em( 'color", 'active', false) => 'r__color--active'
+     */
     em: (sub: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * be( 'color", 'active') => 'el-button-color--active'
+     *
+     * be( 'color", 'active', false) => 'el-color--active'
+     */
     bm: (prefix: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * bem('red', 'color", 'active') => 'el-button-red__color--active'
+     *
+     * bem('red', 'color", 'active', false) => 'el-red__color--active'
+     */
     bem: (prefix: string, sub: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * ebm('close', 'icon", 'hidden') => 'el-button__close-icon--hidden'
+     *
+     * ebm('close', 'icon", 'hidden', false) => 'r__close-icon--hidden'
+     */
     ebm: (sub: string, prefix: string, modifier: string, compName?: boolean) => string;
+    /**
+     * 如果组件前缀是'button':
+     *
+     * is('block', { block: true }) => 'is-block'
+     */
     is: (...classes: ClassValue[]) => string;
 };
 export default useClassNames;

package/dist/hooks/useControlled.d.ts

@@ -1,2 +1,10 @@
+/**
+ * A hook for controlled value management.
+ * In the case of passing the controlled value, the controlled value is returned, otherwise the value in state is returned.
+ * Generally used for a component including controlled and uncontrolled modes.
+ * @param controlledValue
+ * @param defaultValue
+ * @param formatValue
+ */
 declare function useControlled<T>(controlledValue: T, defaultValue?: T): [T, (value: T) => void, boolean];
 export default useControlled;

package/dist/hooks/useForceUpdate.d.ts

@@ -1,3 +1,4 @@
+/** 强制刷新 */
 export declare const useForceUpdate: () => {
     forceUpdate: () => void;
 };