@sequencing/design-system 0.0.34 → 0.0.36

package/dist/types/components/Atoms/Link/Link.d.ts

@@ -1,25 +1,25 @@
 import React, { PropsWithChildren } from "react";
-/**
- * Interface to customize the Link component
- *
- * @param {string=} hint - The hint to be displayed when hovering over the button
- * @param {"next"|"react"} behavior - Should it act like a React or a NextJs link
- * @param {"primary"|"secondary"|"outlined"} variant - Controls the look and feel of the button
- * @param {string} customClass - A class to be added for further customization
- * @param {Function} onClick - Called when a click is performed. The HTML event will be sent to this function
- *
-*/
 export interface LinkProps {
-    hint?: string;
+    /** Custom css class to customize the stylings */
     customClass?: string;
+    /** The hint to be displayed when hovering over the link */
+    hint?: string;
+    /**
+     * The look and feel of the link.
+     * Default: ``primary``
+    */
     variant?: "primary" | "secondary";
+    /** Called when a click is performed. The HTML event will be sent to this function.
+     * Use it to navigate the user to a different page.
+     */
     onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
 }
 /**
  * The Link component is used to render an anchor to navigate between SPA pages.
- * It supports both NextJs and React frameworks through the property ``behavior``.
- *
- * @param {LinkProps} props - Props to customize the Button component, see {@link LinkProps} for more info
+ * To support the different frameworks we have in our repo (React, NextJs, Gatsby),
+ * this component is just a wrapper around an HTML anchor and the navigation should be
+ * handle by the developer using the```onClick`` callback. Passed ``children`` will be
+ * rendered inside the anchor tag.
  *
 */
 declare const Link: ({ hint, children, customClass, variant, onClick, }: PropsWithChildren<LinkProps>) => React.JSX.Element;

package/dist/types/components/Atoms/TextField/TextField.d.ts

@@ -10,18 +10,26 @@ import React, { PropsWithChildren } from "react";
  *
 */
 export interface TextFieldProps {
-    value?: string;
-    variant?: "primary";
-    placeholder?: string;
+    /** Custom css class to customize the stylings */
     customClass?: string;
+    /** Placeholder when there's no text in the field */
+    placeholder?: string;
+    /** If ``true``, a small button will appear at the right side of the text field
+     * to clear its contents
+    */
     showClearButton?: boolean;
+    /** Text to render in the field */
+    value?: string;
+    /**
+     * The look and feel of the link.
+     * Default: ``primary``
+    */
+    variant?: "primary";
+    /** Callback called when the text is updated */
     onChange?: (value: string) => void;
 }
 /**
- * The Link component is used to render an anchor to navigate between SPA pages.
- * It supports both NextJs and React frameworks through the property ``behavior``.
- *
- * @param {TextFieldProps} props - Props to customize the Button component, see {@link TextFieldProps} for more info
+ * The Text Field component renders a simple input field with SDS stylings applied.
  *
 */
 declare const TextField: ({ value, customClass, placeholder, showClearButton, variant, onChange, }: PropsWithChildren<TextFieldProps>) => React.JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencing/design-system",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "private": false,
   "description": "Sequencing Design System",
   "publishConfig": {