reablocks/dist/stories/docs.json

Component library for React

[
  {
    "tags": {},
    "filePath": "src/utils/CloneElement.tsx",
    "description": "CloneElement is a wrapper component for createElement function.\nThis allows you to describe your cloning element declaratively\nwhich is a more natural API for React.",
    "displayName": "CloneElement",
    "methods": [],
    "props": {
      "element": {
        "defaultValue": null,
        "description": "",
        "name": "element",
        "parent": {
          "fileName": "src/utils/CloneElement.tsx",
          "name": "CloneElementProps"
        },
        "declarations": [
          {
            "fileName": "src/utils/CloneElement.tsx",
            "name": "CloneElementProps"
          }
        ],
        "required": true,
        "type": {
          "name": "any"
        }
      },
      "childRef": {
        "defaultValue": null,
        "description": "",
        "name": "childRef",
        "parent": {
          "fileName": "src/utils/CloneElement.tsx",
          "name": "CloneElementProps"
        },
        "declarations": [
          {
            "fileName": "src/utils/CloneElement.tsx",
            "name": "CloneElementProps"
          }
        ],
        "required": false,
        "type": {
          "name": "any"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/DataSize/DataSize.tsx",
    "description": "",
    "displayName": "DataSize",
    "methods": [],
    "props": {
      "value": {
        "defaultValue": null,
        "description": "The size value to render.",
        "name": "value",
        "parent": {
          "fileName": "src/data/DataSize/DataSize.tsx",
          "name": "DataSizeProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DataSize/DataSize.tsx",
            "name": "DataSizeProps"
          }
        ],
        "required": true,
        "type": {
          "name": "FormatSizeTypes"
        }
      },
      "emptyValue": {
        "defaultValue": null,
        "description": "If the value is undefined/null it will return this value.",
        "name": "emptyValue",
        "parent": {
          "fileName": "src/data/DataSize/DataSize.tsx",
          "name": "DataSizeProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DataSize/DataSize.tsx",
            "name": "DataSizeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "scale": {
        "defaultValue": null,
        "description": "Customize scale for displaying units.",
        "name": "scale",
        "parent": {
          "fileName": "src/data/DataSize/DataSize.tsx",
          "name": "DataSizeProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DataSize/DataSize.tsx",
            "name": "DataSizeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string[]"
        }
      },
      "decimals": {
        "defaultValue": null,
        "description": "The number of decimals to be set.",
        "name": "decimals",
        "parent": {
          "fileName": "src/data/DataSize/DataSize.tsx",
          "name": "DataSizeProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DataSize/DataSize.tsx",
            "name": "DataSizeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/DateFormat/DateFormat.tsx",
    "description": "",
    "displayName": "DateFormat",
    "methods": [],
    "props": {
      "allowToggle": {
        "defaultValue": {
          "value": "false"
        },
        "description": "Allow the user to toggle between relative and absolute time.",
        "name": "allowToggle",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "cacheKey": {
        "defaultValue": null,
        "description": "The cache key to use for storing the user's preference.",
        "name": "cacheKey",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "date": {
        "defaultValue": null,
        "description": "The date to format.",
        "name": "date",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string | number | Date"
        }
      },
      "format": {
        "defaultValue": {
          "value": "MM/dd/yy hh:mm:ss a"
        },
        "description": "The format to use.",
        "name": "format",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "fromNow": {
        "defaultValue": null,
        "description": "Whether to use relative time.",
        "name": "fromNow",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "addSuffix": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Whether to add a suffix to the relative time.",
        "name": "addSuffix",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "className": {
        "defaultValue": null,
        "description": "Additional CSS class names to use.",
        "name": "className",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "includeSeconds": {
        "defaultValue": {
          "value": "false"
        },
        "description": "Whether to include seconds in the relative time.",
        "name": "includeSeconds",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "emptyMessage": {
        "defaultValue": {
          "value": "N/A"
        },
        "description": "The message to display when the date is empty. Default is \"N/A\".",
        "name": "emptyMessage",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the DateFormat.",
        "name": "theme",
        "parent": {
          "fileName": "src/data/DateFormat/DateFormat.tsx",
          "name": "DateFormatProps"
        },
        "declarations": [
          {
            "fileName": "src/data/DateFormat/DateFormat.tsx",
            "name": "DateFormatProps"
          }
        ],
        "required": false,
        "type": {
          "name": "DateFormatTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Duration/Duration.tsx",
    "description": "",
    "displayName": "Duration",
    "methods": [],
    "props": {
      "value": {
        "defaultValue": null,
        "description": "Size to pass to the formatter.",
        "name": "value",
        "parent": {
          "fileName": "src/data/Duration/Duration.tsx",
          "name": "DurationProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Duration/Duration.tsx",
            "name": "DurationProps"
          }
        ],
        "required": true,
        "type": {
          "name": "DurationFormatTypes"
        }
      },
      "emptyValue": {
        "defaultValue": {
          "value": "N/A"
        },
        "description": "If the value is undefined/null it will return this value.",
        "name": "emptyValue",
        "parent": {
          "fileName": "src/data/Duration/Duration.tsx",
          "name": "DurationProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Duration/Duration.tsx",
            "name": "DurationProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "zeroValue": {
        "defaultValue": {
          "value": "0 ms"
        },
        "description": "If the value is 0 it will return this value. Default to '0 ms'",
        "name": "zeroValue",
        "parent": {
          "fileName": "src/data/Duration/Duration.tsx",
          "name": "DurationProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Duration/Duration.tsx",
            "name": "DurationProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Ellipsis/Ellipsis.tsx",
    "description": "",
    "displayName": "Ellipsis",
    "methods": [],
    "props": {
      "value": {
        "defaultValue": null,
        "description": "The value to ellipsis.",
        "name": "value",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": true,
        "type": {
          "name": "string"
        }
      },
      "expandable": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Whether you can expand or not. Default: true.",
        "name": "expandable",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "limit": {
        "defaultValue": {
          "value": "256"
        },
        "description": "Limit of characters to show. Default: 256.",
        "name": "limit",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "title": {
        "defaultValue": null,
        "description": "The title text to show on the hover.",
        "name": "title",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string | false"
        }
      },
      "removeLinebreaks": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Remove line breaks or not.",
        "name": "removeLinebreaks",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "className": {
        "defaultValue": null,
        "description": "Class name for the container.",
        "name": "className",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the Ellipsis.",
        "name": "theme",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "EllipsisTheme"
        }
      },
      "lines": {
        "defaultValue": null,
        "description": "Number of lines to show before truncation. If set, overrides the character limit.",
        "name": "lines",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "moreText": {
        "defaultValue": {
          "value": "..."
        },
        "description": "Custom text for the expand button. Default: \"...\"",
        "name": "moreText",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "lessText": {
        "defaultValue": {
          "value": "Show less"
        },
        "description": "Custom text for the collapse button. Default: \"Show less\"",
        "name": "lessText",
        "parent": {
          "fileName": "src/data/Ellipsis/Ellipsis.tsx",
          "name": "EllipsisProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Ellipsis/Ellipsis.tsx",
            "name": "EllipsisProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/InfinityList/InfinityList.tsx",
    "description": "",
    "displayName": "InfinityList",
    "methods": [],
    "props": {
      "children": {
        "defaultValue": null,
        "description": "The children to filter.",
        "name": "children",
        "parent": {
          "fileName": "src/data/InfinityList/InfinityList.tsx",
          "name": "InfinityListProps"
        },
        "declarations": [
          {
            "fileName": "src/data/InfinityList/InfinityList.tsx",
            "name": "InfinityListProps"
          }
        ],
        "required": true,
        "type": {
          "name": "any"
        }
      },
      "buttonClassName": {
        "defaultValue": null,
        "description": "CSS Classname to apply to the button.",
        "name": "buttonClassName",
        "parent": {
          "fileName": "src/data/InfinityList/InfinityList.tsx",
          "name": "InfinityListProps"
        },
        "declarations": [
          {
            "fileName": "src/data/InfinityList/InfinityList.tsx",
            "name": "InfinityListProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "size": {
        "defaultValue": {
          "value": "10"
        },
        "description": "The page size. Combined with the threshold, this will determine the page size.",
        "name": "size",
        "parent": {
          "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
          "name": "InfinityListInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
            "name": "InfinityListInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "threshold": {
        "defaultValue": {
          "value": "3"
        },
        "description": "The fuzzy threshold to use when calculating the next page size.",
        "name": "threshold",
        "parent": {
          "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
          "name": "InfinityListInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
            "name": "InfinityListInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "nextSize": {
        "defaultValue": null,
        "description": "The numer of items to show in the next page. If undefined, will use the size.\nIf you want to show all items, pass infinity.",
        "name": "nextSize",
        "parent": {
          "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
          "name": "InfinityListInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/InfinityList/useInfinityList.ts",
            "name": "InfinityListInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Pager/Pager.tsx",
    "description": "",
    "displayName": "Pager",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "The class name to add to the pager.",
        "name": "className",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "pageClassName": {
        "defaultValue": null,
        "description": "The class name to add to the page buttons.",
        "name": "pageClassName",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "activePageClassName": {
        "defaultValue": null,
        "description": "The class name for the active page button.",
        "name": "activePageClassName",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "pagesContainerClassName": {
        "defaultValue": null,
        "description": "The class name to add to the pages container.",
        "name": "pagesContainerClassName",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "page": {
        "defaultValue": null,
        "description": "The current page number.",
        "name": "page",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": true,
        "type": {
          "name": "number"
        }
      },
      "size": {
        "defaultValue": null,
        "description": "The number of items per page.",
        "name": "size",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": true,
        "type": {
          "name": "number"
        }
      },
      "total": {
        "defaultValue": null,
        "description": "The total number of items.",
        "name": "total",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": true,
        "type": {
          "name": "number"
        }
      },
      "previousArrow": {
        "defaultValue": {
          "value": "<PreviousArrow />"
        },
        "description": "The React node or string to use for the previous arrow.",
        "name": "previousArrow",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      },
      "nextArrow": {
        "defaultValue": {
          "value": "<NextArrow />"
        },
        "description": "The React node or string to use for the next arrow.",
        "name": "nextArrow",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      },
      "startArrow": {
        "defaultValue": {
          "value": "<StartArrow />"
        },
        "description": "The React node or string to use for the start arrow.",
        "name": "startArrow",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      },
      "endArrow": {
        "defaultValue": {
          "value": "<EndArrow />"
        },
        "description": "The React node or string to use for the end arrow.",
        "name": "endArrow",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      },
      "onPageChange": {
        "defaultValue": null,
        "description": "A callback function that is called when the page changes.",
        "name": "onPageChange",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "(page: number) => void"
        }
      },
      "displayMode": {
        "defaultValue": {
          "value": "pages"
        },
        "description": "The type of table data for the pager to display.",
        "name": "displayMode",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "\"pages\" | \"items\" | \"all\""
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "The theme for the Pager.",
        "name": "theme",
        "parent": {
          "fileName": "src/data/Pager/Pager.tsx",
          "name": "PagerProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pager/Pager.tsx",
            "name": "PagerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "PagerTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Pluralize/Pluralize.tsx",
    "description": "",
    "displayName": "Pluralize",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "CSS classname for the span element.",
        "name": "className",
        "parent": {
          "fileName": "src/data/Pluralize/Pluralize.tsx",
          "name": "PluralizeProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Pluralize/Pluralize.tsx",
            "name": "PluralizeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "count": {
        "defaultValue": {
          "value": "0"
        },
        "description": "Count of items.",
        "name": "count",
        "parent": {
          "fileName": "reablocks/src/data/Pluralize/utils.ts",
          "name": "PluralizeInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/Pluralize/utils.ts",
            "name": "PluralizeInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "singular": {
        "defaultValue": null,
        "description": "Singular form of the word.",
        "name": "singular",
        "parent": {
          "fileName": "reablocks/src/data/Pluralize/utils.ts",
          "name": "PluralizeInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/Pluralize/utils.ts",
            "name": "PluralizeInputs"
          }
        ],
        "required": true,
        "type": {
          "name": "string"
        }
      },
      "plural": {
        "defaultValue": null,
        "description": "Plural form of the word. Not required.",
        "name": "plural",
        "parent": {
          "fileName": "reablocks/src/data/Pluralize/utils.ts",
          "name": "PluralizeInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/Pluralize/utils.ts",
            "name": "PluralizeInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "zero": {
        "defaultValue": null,
        "description": "Zero state of the word. Not required.",
        "name": "zero",
        "parent": {
          "fileName": "reablocks/src/data/Pluralize/utils.ts",
          "name": "PluralizeInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/Pluralize/utils.ts",
            "name": "PluralizeInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "showCount": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Show count in addition to word.",
        "name": "showCount",
        "parent": {
          "fileName": "reablocks/src/data/Pluralize/utils.ts",
          "name": "PluralizeInputs"
        },
        "declarations": [
          {
            "fileName": "reablocks/src/data/Pluralize/utils.ts",
            "name": "PluralizeInputs"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Redact/Redact.tsx",
    "description": "",
    "displayName": "Redact",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "Classname of the element.",
        "name": "className",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "allowToggle": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Whether you can toggle the text or not.",
        "name": "allowToggle",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "compactLength": {
        "defaultValue": {
          "value": "8"
        },
        "description": "Number of characters to compact to.",
        "name": "compactLength",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "character": {
        "defaultValue": {
          "value": "*"
        },
        "description": "The character to replace the text with.",
        "name": "character",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "tooltipText": {
        "defaultValue": {
          "value": "Click to toggle sensitive content"
        },
        "description": "Text to show upon hover.",
        "name": "tooltipText",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "value": {
        "defaultValue": null,
        "description": "Value to conceal.",
        "name": "value",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "The theme for the Redact.",
        "name": "theme",
        "parent": {
          "fileName": "src/data/Redact/Redact.tsx",
          "name": "RedactProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Redact/Redact.tsx",
            "name": "RedactProps"
          }
        ],
        "required": false,
        "type": {
          "name": "RedactTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Sort/DownArrowIcon.tsx",
    "description": "",
    "displayName": "DownArrowIcon",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "",
        "name": "className",
        "parent": {
          "fileName": "src/data/Sort/DownArrowIcon.tsx",
          "name": "DownArrowIconProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/DownArrowIcon.tsx",
            "name": "DownArrowIconProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/data/Sort/Sort.tsx",
    "description": "",
    "displayName": "Sort",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "Additional css classnames to apply",
        "name": "className",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "iconClassName": {
        "defaultValue": null,
        "description": "Additional css classnames to apply to the icon",
        "name": "iconClassName",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "disabled": {
        "defaultValue": null,
        "description": "Whether the sort is disabled",
        "name": "disabled",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "direction": {
        "defaultValue": null,
        "description": "The current sort direction",
        "name": "direction",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "SortDirection"
        }
      },
      "onSort": {
        "defaultValue": null,
        "description": "The callback to call when the sort is toggled",
        "name": "onSort",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "(direction: SortDirection) => void"
        }
      },
      "icon": {
        "defaultValue": null,
        "description": "The icon to display",
        "name": "icon",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ComponentType<{ className?: string; }>"
        }
      },
      "neutralIcon": {
        "defaultValue": null,
        "description": "The neutral icon to display.",
        "name": "neutralIcon",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ComponentType<{ className?: string; }>"
        }
      },
      "neutralIconClassName": {
        "defaultValue": null,
        "description": "Additional css classnames to apply to the neutral icon.",
        "name": "neutralIconClassName",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the Sort.",
        "name": "theme",
        "parent": {
          "fileName": "src/data/Sort/Sort.tsx",
          "name": "SortProps"
        },
        "declarations": [
          {
            "fileName": "src/data/Sort/Sort.tsx",
            "name": "SortProps"
          }
        ],
        "required": false,
        "type": {
          "name": "SortTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/elements/Arrow/Arrow.tsx",
    "description": "",
    "displayName": "Arrow",
    "methods": [],
    "props": {
      "className": {
        "defaultValue": null,
        "description": "CSS Classname to apply to the arrow",
        "name": "className",
        "parent": {
          "fileName": "src/elements/Arrow/Arrow.tsx",
          "name": "ArrowProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Arrow/Arrow.tsx",
            "name": "ArrowProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "direction": {
        "defaultValue": {
          "value": "down"
        },
        "description": "The direction of the arrow",
        "name": "direction",
        "parent": {
          "fileName": "src/elements/Arrow/Arrow.tsx",
          "name": "ArrowProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Arrow/Arrow.tsx",
            "name": "ArrowProps"
          }
        ],
        "required": false,
        "type": {
          "name": "\"up\" | \"right\" | \"down\" | \"left\""
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the Arrow.",
        "name": "theme",
        "parent": {
          "fileName": "src/elements/Arrow/Arrow.tsx",
          "name": "ArrowProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Arrow/Arrow.tsx",
            "name": "ArrowProps"
          }
        ],
        "required": false,
        "type": {
          "name": "ArrowTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/elements/Avatar/Avatar.tsx",
    "description": "",
    "displayName": "Avatar",
    "methods": [],
    "props": {
      "name": {
        "defaultValue": null,
        "description": "The name of the person.",
        "name": "name",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "src": {
        "defaultValue": null,
        "description": "The URL of the avatar image.",
        "name": "src",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "size": {
        "defaultValue": {
          "value": "24"
        },
        "description": "The size of the avatar.",
        "name": "size",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "variant": {
        "defaultValue": {
          "value": "filled"
        },
        "description": "Style variant for the avatar.",
        "name": "variant",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "\"filled\" | \"outline\""
        }
      },
      "rounded": {
        "defaultValue": {
          "value": "true"
        },
        "description": "Whether the avatar is rounded.",
        "name": "rounded",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "color": {
        "defaultValue": null,
        "description": "Color override for the avatar.",
        "name": "color",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "colorOptions": {
        "defaultValue": null,
        "description": "Custom color options for the color generator.",
        "name": "colorOptions",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "{ saturation: number; lightness: number; alpha: number; }"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the Avatar.",
        "name": "theme",
        "parent": {
          "fileName": "src/elements/Avatar/Avatar.tsx",
          "name": "AvatarProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Avatar/Avatar.tsx",
            "name": "AvatarProps"
          }
        ],
        "required": false,
        "type": {
          "name": "AvatarTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/elements/AvatarGroup/AvatarGroup.tsx",
    "description": "",
    "displayName": "AvatarGroup",
    "methods": [],
    "props": {
      "children": {
        "defaultValue": null,
        "description": "The avatars to display in the group.",
        "name": "children",
        "parent": {
          "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
          "name": "AvatarGroupProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
            "name": "AvatarGroupProps"
          }
        ],
        "required": true,
        "type": {
          "name": "ReactNode"
        }
      },
      "className": {
        "defaultValue": null,
        "description": "Additional CSS classes to apply to the avatar group",
        "name": "className",
        "parent": {
          "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
          "name": "AvatarGroupProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
            "name": "AvatarGroupProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "size": {
        "defaultValue": {
          "value": "10"
        },
        "description": "The maximum number of avatars to show before +x more",
        "name": "size",
        "parent": {
          "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
          "name": "AvatarGroupProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
            "name": "AvatarGroupProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "theme": {
        "defaultValue": null,
        "description": "Theme for the AvatarGroup",
        "name": "theme",
        "parent": {
          "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
          "name": "AvatarGroupProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/AvatarGroup/AvatarGroup.tsx",
            "name": "AvatarGroupProps"
          }
        ],
        "required": false,
        "type": {
          "name": "AvatarGroupTheme"
        }
      }
    }
  },
  {
    "tags": {},
    "filePath": "src/elements/Badge/Badge.tsx",
    "description": "",
    "displayName": "Badge",
    "methods": [],
    "props": {
      "content": {
        "defaultValue": null,
        "description": "The content of the badge.",
        "name": "content",
        "parent": {
          "fileName": "src/elements/Badge/Badge.tsx",
          "name": "BadgeProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Badge/Badge.tsx",
            "name": "BadgeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string | Element"
        }
      },
      "color": {
        "defaultValue": {
          "value": "default"
        },
        "description": "The color of the badge.",
        "name": "color",
        "parent": {
          "fileName": "src/elements/Badge/Badge.tsx",
          "name": "BadgeProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Badge/Badge.tsx",
            "name": "BadgeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "disableMargins": {
        "defaultValue": null,
        "description": "Whether to disable the margins.",
        "name": "disableMargins",
        "parent": {
          "fileName": "src/elements/Badge/Badge.tsx",
          "name": "BadgeProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Badge/Badge.tsx",
            "name": "BadgeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "hidden": {
        "defaultValue": null,
        "description": "Whether the badge is hidden or not.",
        "name": "hidden",
        "parent": {
          "fileName": "src/elements/Badge/Badge.tsx",
          "name": "BadgeProps"
        },
        "declarations": [
          {
            "fileName": "src/elements/Badge/Badge.tsx",
            "name": "BadgeProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "placement": {
        "defaultValue": {
          "value": "top-end"
        },
        "description": "The placement of the badge.",
        "name": "placement",