Document AutoNumericComponent (#6)

Author: xuhdev

package-lock.json

@@ -63,6 +63,7 @@
     "typedoc": "^0.25.13",
     "typedoc-plugin-extra-footer": "^1.0.1",
     "typedoc-plugin-mdn-links": "^3.1.22",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.7.0",
     "vite": "^5.2.9",

package.json

@@ -18,6 +18,21 @@
 import AutoNumeric, { CallbackOptions } from "autonumeric";
 import { ReactHTML, createElement, useEffect, useRef } from "react";
 
+/** The base React component integrated with {@link !AutoNumeric}.
+ *
+ * This component is used as a base to construct higher-level React component that integrates with
+ * AutoNumeric. See {@link AutoNumericInput} for a live example.
+ *
+ * @param options - Options of the component.
+ * @param options.element - The element of the component, such as `"input"`.
+ * @param options.refKey - The name of the attribute that refers the underlying DOM element. This is
+ * typically [`"ref"`](https://react.dev/learn/manipulating-the-dom-with-refs).
+ * @param options.props - Options passed to the underlying element `options.element`.
+ * @param options.autoNumericOptions - Options passed to {@link !AutoNumeric}. Same as {@link
+ * AutoNumeric!Options}.
+ * @param options.state - The React state that controls and is controlled by {@link !AutoNumeric}.
+ * If absent, this component will not interact with its parent via React states.
+ */
 export default function AutoNumericComponent({
   element,
   refKey,

src/lib/AutoNumericComponent.tsx

@@ -5,11 +5,13 @@
     "./src/lib/AutoNumericComponent.tsx",
     "./src/lib/AutoNumericInput.tsx"
   ],
+  "entryPointStrategy": "expand",
   "plugin": [
     "@8hobbies/typedoc-plugin-404",
     "@8hobbies/typedoc-plugin-plausible",
     "typedoc-plugin-extra-footer",
-    "typedoc-plugin-mdn-links"
+    "typedoc-plugin-mdn-links",
+    "typedoc-plugin-rename-defaults"
   ],
   "sitemapBaseUrl": "https://react-autonumeric.8hob.io",
   "externalSymbolLinkMappings": {