@agnos-ui/react-bootstrap 0.6.0-next.2 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,10 +10,10 @@ export declare const AccordionItemDefaultSlotStructure: (slotContext: AccordionI
10
10
  /**
11
11
  * AccordionItem component is a part of the Accordion component suite.
12
12
  *
13
- * @param {Partial<AccordionItemProps>} props - The properties for the AccordionItem component.
14
- * @param {ForwardedRef<AccordionItemApi>} ref - The forwarded ref to the AccordionItemApi.
13
+ * @param props - The properties for the AccordionItem component.
14
+ * @param ref - The forwarded ref to the AccordionItemApi.
15
15
  *
16
- * @returns {JSX.Element} The rendered AccordionItem component.
16
+ * @returns The rendered AccordionItem component.
17
17
  * @remarks
18
18
  * This component uses several hooks:
19
19
  * - {@link https://react.dev/reference/react/useContext | useContext} to get the `registerItem` function from {@link AccordionDIContext}.
@@ -34,10 +34,10 @@ export declare const AccordionItem: ForwardRefExoticComponent<Partial<AccordionI
34
34
  * It leverages the {@link useWidgetWithConfig} hook to create the accordion widget and
35
35
  * {@link https://react.dev/reference/react/useImperativeHandle | useImperativeHandle} to bind the widget API to the ref.
36
36
  *
37
- * @param {PropsWithChildren<Partial<AccordionProps>>} props - The properties for the Accordion component.
38
- * @param {ForwardedRef<AccordionApi>} ref - The ref to be forwarded to the Accordion API.
37
+ * @param props - The properties for the Accordion component.
38
+ * @param ref - The ref to be forwarded to the Accordion API.
39
39
  *
40
- * @returns {JSX.Element} The rendered Accordion component.
40
+ * @returns The rendered Accordion component.
41
41
  *
42
42
  */
43
43
  export declare const Accordion: ForwardRefExoticComponent<PropsWithChildren<Partial<AccordionProps>> & RefAttributes<AccordionApi>>;
@@ -21,10 +21,10 @@ export declare const ModalDefaultSlotStructure: <Data>(slotContext: ModalContext
21
21
  *
22
22
  * @template Data - The type of data that the modal will handle.
23
23
  *
24
- * @param {Partial<ModalProps<Data>>} props - The properties for the Modal component.
25
- * @param {Ref<ModalApi<Data>>} ref - A ref to access the Modal API.
24
+ * @param props - The properties for the Modal component.
25
+ * @param ref - A ref to access the Modal API.
26
26
  *
27
- * @returns {JSX.Element} The rendered Modal component.
27
+ * @returns The rendered Modal component.
28
28
  */
29
29
  export declare const Modal: <Data>(props: Partial<ModalProps<Data>> & RefAttributes<ModalApi<Data>>) => JSX.Element;
30
30
  /**
@@ -20,18 +20,17 @@ interface NavItemProps extends React.HTMLAttributes<HTMLAnchorElement> {
20
20
  * with the appropriate classes for pagination. It uses `React.forwardRef` to
21
21
  * forward the ref to the `<li>` element.
22
22
  *
23
- * @param {PageItemProps} props - The properties passed to the component.
24
- * @param {boolean} props.disabled - If true, the page item will be disabled.
25
- * @param {boolean} props.active - If true, the page item will be marked as active.
26
- * @param {string} [props.activeLabel] - An optional label for the active page item,
27
- * which will be visually hidden but accessible to screen readers.
28
- * @param {string} [props.className] - Additional class names to apply to the page link.
29
- * @param {React.ReactNode} props.children - The content to be displayed inside the page link.
30
- * @param {any} props.directive - A directive to be used with the `useDirectives` hook.
31
- * @param {any} props.page - The page number or identifier.
32
- * @param {React.Ref<HTMLLIElement>} ref - The ref to be forwarded to the `<li>` element.
23
+ * @param props - The properties passed to the component.
24
+ * @param props.disabled - If true, the page item will be disabled.
25
+ * @param props.active - If true, the page item will be marked as active.
26
+ * @param props.activeLabel - An optional label for the active page item, which will be visually hidden but accessible to screen readers.
27
+ * @param props.className - Additional class names to apply to the page link.
28
+ * @param props.children - The content to be displayed inside the page link.
29
+ * @param props.directive - A directive to be used with the `useDirectives` hook.
30
+ * @param props.page - The page number or identifier.
31
+ * @param ref - The ref to be forwarded to the `<li>` element.
33
32
  *
34
- * @returns {JSX.Element} The rendered page item component.
33
+ * @returns The rendered page item component.
35
34
  */
36
35
  export declare const PageItem: React.ForwardRefExoticComponent<PageItemProps & React.RefAttributes<HTMLLIElement>>;
37
36
  /**
@@ -39,14 +38,14 @@ export declare const PageItem: React.ForwardRefExoticComponent<PageItemProps & R
39
38
  * within a list item (`<li>`) element. It uses `React.forwardRef` to forward the ref
40
39
  * to the `<li>` element.
41
40
  *
42
- * @param {NavItemProps} props - The properties passed to the component.
43
- * @param {boolean} props.disabled - Determines if the navigation button is disabled.
44
- * @param {string} props.className - Additional class names to apply to the button.
45
- * @param {React.ReactNode} props.children - The content to be displayed inside the button.
46
- * @param {any} props.directive - Directives to be applied to the anchor (`<a>`) element.
47
- * @param {React.Ref<HTMLLIElement>} ref - The ref to be forwarded to the `<li>` element.
41
+ * @param props - The properties passed to the component.
42
+ * @param props.disabled - Determines if the navigation button is disabled.
43
+ * @param props.className - Additional class names to apply to the button.
44
+ * @param props.children - The content to be displayed inside the button.
45
+ * @param props.directive - Directives to be applied to the anchor (`<a>`) element.
46
+ * @param ref - The ref to be forwarded to the `<li>` element.
48
47
  *
49
- * @returns {JSX.Element} A list item containing a navigation button.
48
+ * @returns A list item containing a navigation button.
50
49
  */
51
50
  export declare const NavButton: React.ForwardRefExoticComponent<NavItemProps & React.RefAttributes<HTMLLIElement>>;
52
51
  export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@agnos-ui/react-bootstrap",
3
3
  "description": "Bootstrap-based component library for React.",
4
- "version": "0.6.0-next.2",
4
+ "version": "0.6.0",
5
5
  "type": "module",
6
6
  "main": "./index.cjs",
7
7
  "module": "./index.js",
@@ -49,8 +49,8 @@
49
49
  }
50
50
  },
51
51
  "dependencies": {
52
- "@agnos-ui/core-bootstrap": "0.6.0-next.2",
53
- "@agnos-ui/react-headless": "0.6.0-next.2",
52
+ "@agnos-ui/core-bootstrap": "0.6.0",
53
+ "@agnos-ui/react-headless": "0.6.0",
54
54
  "classnames": "^2.5.1"
55
55
  },
56
56
  "peerDependencies": {