@indico-data/design-system 3.0.10 → 3.1.0

package/src/components/tooltip/Tooltip.stories.tsx

@@ -9,8 +9,6 @@ const meta: Meta = {
   argTypes: {
     id: {
       control: false,
-      description:
-        "The id of the tooltip. This needs to match the element that holds it's data attribute",
       table: {
         category: 'Props',
         type: {
@@ -20,7 +18,6 @@ const meta: Meta = {
     },
     place: {
       control: 'select',
-      description: 'The placement of the tooltip',
       options: ['top', 'top-start', 'top-end', 'right', 'right-start', 'right-end', 'bottom'],
       table: {
         category: 'Props',
@@ -31,7 +28,6 @@ const meta: Meta = {
     },
     clickToShow: {
       control: 'boolean',
-      description: 'Whether the tooltip should be shown on click',
       table: {
         category: 'Props',
         type: {
@@ -41,7 +37,6 @@ const meta: Meta = {
     },
     delayShow: {
       control: 'number',
-      description: 'The delay in milliseconds before the tooltip is shown',
       table: {
         category: 'Props',
         type: {
@@ -51,7 +46,6 @@ const meta: Meta = {
     },
     delayHide: {
       control: 'number',
-      description: 'The delay in milliseconds before the tooltip is hidden',
       table: {
         category: 'Props',
         type: {
@@ -61,7 +55,6 @@ const meta: Meta = {
     },
     zIndex: {
       control: 'number',
-      description: 'This is an override for the z-index of the tooltip',
       table: {
         category: 'Props',
         type: {
@@ -71,7 +64,6 @@ const meta: Meta = {
     },
     children: {
       control: false,
-      description: 'The content of the tooltip',
       table: {
         category: 'Props',
         type: {

package/src/components/tooltip/Tooltip.tsx

@@ -2,12 +2,18 @@ import { PlacesType, Tooltip as ReactTooltip } from 'react-tooltip';
 
 interface TooltipProps {
   id: string;
+  /** Whether the tooltip should be shown on click */
   clickToShow?: boolean;
+  /** The delay in milliseconds before the tooltip is shown */
   delayShow?: number;
+  /** The delay in milliseconds before the tooltip is hidden */
   delayHide?: number;
   children: React.ReactNode;
+  /** This is an override for the z-index of the tooltip */
   zIndex?: number;
+  /** The placement of the tooltip */
   place?: PlacesType;
+  /** The content of the tooltip */
   [key: string]: any;
 }
 

package/src/components/truncate/Truncate.stories.tsx

@@ -16,8 +16,6 @@ const meta: Meta<typeof Truncate> = {
     truncateString: {
       required: true,
       control: 'text',
-      description:
-        'The string to truncate. This value will also be displayed in the tooltip when the text is truncated.',
       table: {
         category: 'Props',
       },
@@ -25,16 +23,12 @@ const meta: Meta<typeof Truncate> = {
     lineClamp: {
       control: 'number',
       defaultValue: 0,
-      description:
-        'The number of lines to truncate the text to. If left blank, it will default to 1 line.',
       table: {
         category: 'Props',
       },
     },
     tooltipId: {
       control: 'text',
-      description:
-        'The id of the tooltip. If an ID is not provided, it will generate one from uuid',
       table: {
         category: 'Props',
       },
@@ -42,8 +36,6 @@ const meta: Meta<typeof Truncate> = {
     hasTooltip: {
       control: 'boolean',
       defaultValue: true,
-      description:
-        'Whether to show the tooltip. If left blank, it will default to true. If set to false, the tooltip will not be shown.',
       table: {
         category: 'Props',
       },

package/src/components/truncate/types.ts

@@ -1,7 +1,11 @@
 export interface TruncateProps {
+  /** The number of lines to truncate the text to. If left blank, it will default to 1 line. */
   lineClamp?: number;
+  /** The string to truncate. This value will also be displayed in the tooltip when the text is truncated. */
   truncateString: string;
+  /** Whether to show the tooltip. If left blank, it will default to true. If set to false, the tooltip will not be shown. */
   hasTooltip?: boolean;
+  /** The id of the tooltip. If an ID is not provided, it will generate one from uuid */
   tooltipId?: string;
   [key: string]: any;
 }