diff --git a/packages/docusaurus-theme/package.json b/packages/docusaurus-theme/package.json index f711130da04..7d54b6af02a 100644 --- a/packages/docusaurus-theme/package.json +++ b/packages/docusaurus-theme/package.json @@ -18,6 +18,7 @@ "@types/react": "^18.3.3", "@types/react-dom": "^18.3.0", "@types/react-is": "^18", + "typedoc": "^0.28.4", "typescript": "~5.5.4" }, "main": "lib/index.js", diff --git a/packages/docusaurus-theme/src/components/demo/code_transformer.ts b/packages/docusaurus-theme/src/components/demo/code_transformer.ts index 17369630c9d..26997d2cd87 100644 --- a/packages/docusaurus-theme/src/components/demo/code_transformer.ts +++ b/packages/docusaurus-theme/src/components/demo/code_transformer.ts @@ -24,8 +24,8 @@ const COMPONENT_ONLY_REGEX = /^\(? { // Remove ESM imports diff --git a/packages/docusaurus-theme/src/components/prop_table/prop_table.tsx b/packages/docusaurus-theme/src/components/prop_table/prop_table.tsx index 11d8413ac06..86efeeaa88e 100644 --- a/packages/docusaurus-theme/src/components/prop_table/prop_table.tsx +++ b/packages/docusaurus-theme/src/components/prop_table/prop_table.tsx @@ -16,8 +16,11 @@ import { } from '@elastic/eui-docgen'; import { useCallback, useMemo } from 'react'; import { css } from '@emotion/react'; -import { PropTableExtendedTypes } from './extended_types'; import Heading from '@theme/Heading'; +import types from '@elastic/eui-docgen/dist/types.json'; +import { JSONOutput } from 'typedoc'; + +import { PropTableExtendedTypes } from './extended_types'; export interface PropTableProps { definition: ProcessedComponent; @@ -136,15 +139,31 @@ export const PropTable = ({ value: ProcessedComponentProp['description'], prop: ProcessedComponentProp ) { + const result = value + .replace(/{@link (\w+)}/g, (_, componentName) => { + const componentSource = ( + types as unknown as JSONOutput.ProjectReflection + ).children?.find((item) => item.name === componentName) + ?.sources?.[0]; + + if (componentSource) { + const { fileName, line } = componentSource; + return `[${componentName}](https://github.com/elastic/eui/tree/main/packages/${fileName}#L${line})`; + } else { + return `\`${componentName}\``; + } + }) + .trim(); + return ( - {value?.trim() && ( + {result && ( - {value} + {result} )} {prop.type && ( diff --git a/packages/eui-docgen/package.json b/packages/eui-docgen/package.json index 949a5c991f6..245d6c38a78 100644 --- a/packages/eui-docgen/package.json +++ b/packages/eui-docgen/package.json @@ -5,7 +5,8 @@ "scripts": { "clear": "rimraf dist/ lib/", "generate": "ts-node src/main.ts", - "build": "tsc && yarn generate" + "build": "tsc && yarn generate && yarn typedoc", + "typedoc": "typedoc" }, "repository": { "type": "git", @@ -18,10 +19,11 @@ "glob": "^11.0.0", "react-docgen-typescript": "^2.2.2", "ts-node": "^10.9.2", - "typescript": "~5.5.4" + "typescript": "^5.8.3" }, "devDependencies": { - "rimraf": "^6.0.1" + "rimraf": "^6.0.1", + "typedoc": "^0.28.3" }, "files": [ "dist", diff --git a/packages/eui-docgen/typedoc.json b/packages/eui-docgen/typedoc.json new file mode 100644 index 00000000000..f22f8071642 --- /dev/null +++ b/packages/eui-docgen/typedoc.json @@ -0,0 +1,12 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["../eui"], + "entryPointStrategy": "packages", + "outputs": [ + { + "name": "json", + "path": "dist/types.json", + } + ], + "exclude": ["**/node_modules/**"] +} \ No newline at end of file diff --git a/packages/eui-theme-common/src/global_styling/variables/typography.ts b/packages/eui-theme-common/src/global_styling/variables/typography.ts index 80ebbc8b1cb..205d6deb220 100644 --- a/packages/eui-theme-common/src/global_styling/variables/typography.ts +++ b/packages/eui-theme-common/src/global_styling/variables/typography.ts @@ -138,7 +138,7 @@ export interface _EuiThemeTitle { export type _EuiThemeFont = _EuiThemeFontBase & { scale: _EuiThemeFontScales; /** - * @see {@link https://eui.elastic.co/#/theming/typography/values%23font-weight | Reference} for more information + * See {@link https://eui.elastic.co/#/theming/typography/values%23font-weight | Reference} for more information */ weight: _EuiThemeFontWeights; body: _EuiThemeBody; diff --git a/packages/eui-theme-common/src/services/theme/types.ts b/packages/eui-theme-common/src/services/theme/types.ts index 8dd56f356a0..ababd204dd8 100644 --- a/packages/eui-theme-common/src/services/theme/types.ts +++ b/packages/eui-theme-common/src/services/theme/types.ts @@ -64,7 +64,7 @@ export type EuiThemeShapeBase = { /** - Default value: 16 */ base: _EuiThemeBase; /** - * @see {@link https://eui.elastic.co/#/theming/sizing | Reference} for more information + * See {@link https://eui.elastic.co/#/theming/sizing | Reference} for more information */ size: _EuiThemeSizes; font: _EuiThemeFont; diff --git a/packages/eui/.storybook/main.ts b/packages/eui/.storybook/main.ts index 223a2a8ee6d..9edf2b3a5c8 100644 --- a/packages/eui/.storybook/main.ts +++ b/packages/eui/.storybook/main.ts @@ -18,7 +18,7 @@ import type { StorybookConfig } from '@storybook/react-webpack5'; * itself would return a path to the entry point that could be anywhere within * that package's directory. * - * @see {@link https://github.com/storybookjs/storybook/issues/21710#issuecomment-1604260157} + * @see https://github.com/storybookjs/storybook/issues/21710#issuecomment-1604260157 */ const getAbsoluteDependencyPath = (packageName: string) => path.dirname(require.resolve(path.join(packageName, 'package.json'))); diff --git a/packages/eui/changelogs/upcoming/8626.md b/packages/eui/changelogs/upcoming/8626.md new file mode 100644 index 00000000000..234b6fbcb75 --- /dev/null +++ b/packages/eui/changelogs/upcoming/8626.md @@ -0,0 +1,3 @@ +**Dependency updates** + +- Updated `typescript` to v5.8.3 diff --git a/packages/eui/src/components/basic_table/basic_table.tsx b/packages/eui/src/components/basic_table/basic_table.tsx index ee91e22059f..07bd91ddac4 100644 --- a/packages/eui/src/components/basic_table/basic_table.tsx +++ b/packages/eui/src/components/basic_table/basic_table.tsx @@ -227,7 +227,7 @@ interface BasicTableProps */ cellProps?: object | CellPropsCallback; /** - * An array of one of the objects: #EuiTableFieldDataColumnType, #EuiTableComputedColumnType or #EuiTableActionsColumnType. + * An array of one of the objects: {@link EuiTableFieldDataColumnType}, {@link EuiTableComputedColumnType} or {@link EuiTableActionsColumnType}. */ columns: Array>; /** @@ -251,11 +251,12 @@ interface BasicTableProps */ noItemsMessage?: ReactNode; /** - * Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured). See #Criteria or #CriteriaWithPagination + * Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured). + * See {@link Criteria} or {@link CriteriaWithPagination} */ onChange?: (criteria: Criteria) => void; /** - * Configures #Pagination + * Configures {@link Pagination} */ pagination?: undefined; /** @@ -263,11 +264,11 @@ interface BasicTableProps */ rowProps?: object | RowPropsCallback; /** - * Configures #EuiTableSelectionType + * Configures {@link EuiTableSelectionType} */ selection?: EuiTableSelectionType; /** - * Configures #EuiTableSortingType + * Configures {@link EuiTableSortingType} */ sorting?: EuiTableSortingType; /** diff --git a/packages/eui/src/components/basic_table/in_memory_table.tsx b/packages/eui/src/components/basic_table/in_memory_table.tsx index c85fefba32d..70a42f511a6 100644 --- a/packages/eui/src/components/basic_table/in_memory_table.tsx +++ b/packages/eui/src/components/basic_table/in_memory_table.tsx @@ -77,7 +77,7 @@ type InMemoryTableProps = Omit< > & { message?: ReactNode; /** - * Configures #Search. + * Configures {@link Search}. */ search?: Search; /** @@ -93,11 +93,11 @@ type InMemoryTableProps = Omit< */ searchFormat?: 'eql' | 'text'; /** - * Configures #Pagination + * Configures {@link Pagination} */ pagination?: undefined; /** - * Configures #EuiTableSortingType + * Configures {@link EuiTableSortingType} */ sorting?: Sorting; /** @@ -107,11 +107,13 @@ type InMemoryTableProps = Omit< /** * `onChange` is not required when `pagination` and/or `sorting` are configured, * but if `onChange` is present it is responsible for handling state for each/both. - * See #Criteria or #CriteriaWithPagination + * See {@link Criteria} or {@link CriteriaWithPagination} */ onChange?: EuiBasicTableProps['onChange']; /** - * Callback for when table pagination or sorting is changed. This is meant to be informational only, and not used to set any state as the in-memory table already manages this state. See #Criteria or #CriteriaWithPagination. + * Callback for when table pagination or sorting is changed. This is meant to be informational only, + * and not used to set any state as the in-memory table already manages this state. + * See {@link Criteria} or {@link CriteriaWithPagination}. */ onTableChange?: (nextValues: Criteria) => void; executeQueryOptions?: { diff --git a/packages/eui/src/components/basic_table/table_types.ts b/packages/eui/src/components/basic_table/table_types.ts index 447b948249f..840f0803edb 100644 --- a/packages/eui/src/components/basic_table/table_types.ts +++ b/packages/eui/src/components/basic_table/table_types.ts @@ -163,7 +163,7 @@ export type EuiTableComputedColumnType = CommonProps & export type EuiTableActionsColumnType = { /** - * An array of one of the objects: #DefaultItemAction or #CustomItemAction + * An array of one of the objects: {@link DefaultItemAction} or {@link CustomItemAction} */ actions: Array>; /** diff --git a/packages/eui/src/components/breadcrumbs/types.ts b/packages/eui/src/components/breadcrumbs/types.ts index 3bdf8458255..b2f70cd211b 100644 --- a/packages/eui/src/components/breadcrumbs/types.ts +++ b/packages/eui/src/components/breadcrumbs/types.ts @@ -32,7 +32,7 @@ export type EuiBreadcrumbResponsiveMaxCount = { export type EuiBreadcrumbsProps = CommonProps & { /** * Hides extra (above the max) breadcrumbs under a collapsed item as the window gets smaller. - * Pass a custom #EuiBreadcrumbResponsiveMaxCount object to change the number of breadcrumbs to show at the particular breakpoints. + * Pass a custom {@link EuiBreadcrumbResponsiveMaxCount} object to change the number of breadcrumbs to show at the particular breakpoints. * * Pass `false` to turn this behavior off. * @@ -55,7 +55,7 @@ export type EuiBreadcrumbsProps = CommonProps & { max?: number | null; /** - * The array of individual #EuiBreadcrumb items + * The array of individual {@link EuiBreadcrumb} items */ breadcrumbs: EuiBreadcrumbProps[]; diff --git a/packages/eui/src/components/button/button_group/button_group.tsx b/packages/eui/src/components/button/button_group/button_group.tsx index d1f219fbf2a..7ea07f1387b 100644 --- a/packages/eui/src/components/button/button_group/button_group.tsx +++ b/packages/eui/src/components/button/button_group/button_group.tsx @@ -100,7 +100,7 @@ export type EuiButtonGroupProps = CommonProps & { */ type?: 'single' | 'multi'; /** - * An array of #EuiButtonGroupOptionProps + * An array of {@link EuiButtonGroupOptionProps} */ options: EuiButtonGroupOptionProps[]; } & ( diff --git a/packages/eui/src/components/collapsible_nav_beta/collapsible_nav_item/collapsible_nav_item.tsx b/packages/eui/src/components/collapsible_nav_beta/collapsible_nav_item/collapsible_nav_item.tsx index b500d38ff00..371c6cb0c16 100644 --- a/packages/eui/src/components/collapsible_nav_beta/collapsible_nav_item/collapsible_nav_item.tsx +++ b/packages/eui/src/components/collapsible_nav_beta/collapsible_nav_item/collapsible_nav_item.tsx @@ -88,7 +88,7 @@ export type EuiCollapsibleNavItemProps = _SharedEuiCollapsibleNavItemProps & /** * Will render either an accordion or group of nested child item links. * - * Accepts any #EuiCollapsibleNavItemProps. Or, to render completely custom + * Accepts any {@link EuiCollapsibleNavItemProps}. Or, to render completely custom * subitem content, pass an object with a `renderItem` callback. */ items: EuiCollapsibleNavSubItemProps[]; diff --git a/packages/eui/src/components/color_picker/color_palette_display/color_palette_display.tsx b/packages/eui/src/components/color_picker/color_palette_display/color_palette_display.tsx index 0937b5ce651..7ebe117f389 100644 --- a/packages/eui/src/components/color_picker/color_palette_display/color_palette_display.tsx +++ b/packages/eui/src/components/color_picker/color_palette_display/color_palette_display.tsx @@ -29,7 +29,7 @@ export type EuiColorPaletteDisplaySize = (typeof SIZES)[number]; export interface EuiColorPaletteDisplayShared { /** - * Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range. + * Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range. */ palette: string[] | PaletteColorStop[]; } diff --git a/packages/eui/src/components/color_picker/color_palette_picker/color_palette_picker.tsx b/packages/eui/src/components/color_picker/color_palette_picker/color_palette_picker.tsx index c4ba2da67df..f6516c902ad 100644 --- a/packages/eui/src/components/color_picker/color_palette_picker/color_palette_picker.tsx +++ b/packages/eui/src/components/color_picker/color_palette_picker/color_palette_picker.tsx @@ -47,7 +47,7 @@ export interface EuiColorPalettePickerPaletteTextProps extends CommonProps { */ type: 'text'; /** - * Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range. + * Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range. */ palette?: string[] | PaletteColorStop[]; } @@ -70,7 +70,7 @@ export interface EuiColorPalettePickerPaletteFixedProps extends CommonProps { */ type: 'fixed'; /** - * Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range. + * Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range. */ palette: string[] | PaletteColorStop[]; } @@ -93,7 +93,7 @@ export interface EuiColorPalettePickerPaletteGradientProps extends CommonProps { */ type: 'gradient'; /** - * Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range. + * Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range. */ palette: string[] | PaletteColorStop[]; } @@ -114,7 +114,7 @@ export type EuiColorPalettePickerProps = CommonProps & selectionDisplay?: 'palette' | 'title'; /** - * An array of one of the following objects: #EuiColorPalettePickerPaletteText, #EuiColorPalettePickerPaletteFixed, #EuiColorPalettePickerPaletteGradient + * An array of one of the following objects: {@link EuiColorPalettePickerPaletteText}, {@link EuiColorPalettePickerPaletteFixed}, {@link EuiColorPalettePickerPaletteGradient} */ palettes: EuiColorPalettePickerPaletteProps[]; }; diff --git a/packages/eui/src/components/combo_box/combo_box_options_list/combo_box_options_list.tsx b/packages/eui/src/components/combo_box/combo_box_options_list/combo_box_options_list.tsx index 647b6e37a5c..3b80aae71a6 100644 --- a/packages/eui/src/components/combo_box/combo_box_options_list/combo_box_options_list.tsx +++ b/packages/eui/src/components/combo_box/combo_box_options_list/combo_box_options_list.tsx @@ -75,7 +75,7 @@ export type EuiComboBoxOptionsListProps = CommonProps & { onOptionEnterKey?: OptionHandler; onScroll?: ListProps['onScroll']; /** - * Array of EuiComboBoxOptionOption objects. See #EuiComboBoxOptionOption + * Array of EuiComboBoxOptionOption objects. See {@link EuiComboBoxOptionOption} */ options: Array>; renderOption?: ( diff --git a/packages/eui/src/components/comment_list/comment_list.tsx b/packages/eui/src/components/comment_list/comment_list.tsx index 76f776313a9..4f9001aba54 100644 --- a/packages/eui/src/components/comment_list/comment_list.tsx +++ b/packages/eui/src/components/comment_list/comment_list.tsx @@ -16,7 +16,7 @@ export type EuiCommentListProps = Omit< 'items' | 'gutterSize' > & { /** - * List of comments to render. See #EuiComment + * List of comments to render. See {@link EuiComment} */ comments?: EuiCommentProps[]; /** diff --git a/packages/eui/src/components/datagrid/data_grid_types.ts b/packages/eui/src/components/datagrid/data_grid_types.ts index 998794e1b41..ed71c15e3d9 100644 --- a/packages/eui/src/components/datagrid/data_grid_types.ts +++ b/packages/eui/src/components/datagrid/data_grid_types.ts @@ -86,7 +86,7 @@ export interface SchemaTypeScore { } export interface EuiDataGridSchemaDetector { /** - * The name of this data type, matches #EuiDataGridColumn / `schema` + * The name of this data type, matches {@link EuiDataGridColumn} / `schema` */ type: string; /** @@ -119,7 +119,7 @@ export interface EuiDataGridSchemaDetector { */ sortTextDesc: ReactNode; /** - * Whether columns with this schema are sortable (defaults to true). Can be overridden at the individual #EuiDataGridColumn level + * Whether columns with this schema are sortable (defaults to true). Can be overridden at the individual {@link EuiDataGridColumn} level */ isSortable?: boolean; /** @@ -127,7 +127,7 @@ export interface EuiDataGridSchemaDetector { */ textTransform?: 'uppercase' | 'lowercase' | 'capitalize'; /** - * Default sort direction of columns with this schema. Can be overridden at the individual #EuiDataGridColumn level + * Default sort direction of columns with this schema. Can be overridden at the individual {@link EuiDataGridColumn} level */ defaultSortDirection?: 'asc' | 'desc'; } @@ -240,27 +240,27 @@ export interface DataGridCellPopoverContextShape { export type CommonGridProps = CommonProps & HTMLAttributes & { /** - * An array of #EuiDataGridColumn objects. Lists the columns available and the schema and settings tied to it. + * An array of {@link EuiDataGridColumn} objects. Lists the columns available and the schema and settings tied to it. */ columns: EuiDataGridColumn[]; /** - * An array of #EuiDataGridControlColumn objects. Used to define ancillary columns on the left side of the data grid. + * An array of {@link EuiDataGridControlColumn} objects. Used to define ancillary columns on the left side of the data grid. * Useful for adding items like checkboxes and buttons. */ leadingControlColumns?: EuiDataGridControlColumn[]; /** - * An array of #EuiDataGridControlColumn objects. Used to define ancillary columns on the right side of the data grid. + * An array of {@link EuiDataGridControlColumn} objects. Used to define ancillary columns on the right side of the data grid. * Useful for adding items like checkboxes and buttons. */ trailingControlColumns?: EuiDataGridControlColumn[]; /** - * An array of #EuiDataGridColumnVisibility objects. + * An array of {@link EuiDataGridColumnVisibility} objects. * Defines which columns are **intitially** visible in the grid and the order they are displayed. * Users can still turn their visibility on/off when `toolbarVisibility.showColumnSelector = true` (which is the default). */ columnVisibility: EuiDataGridColumnVisibility; /** - * An array of custom #EuiDataGridSchemaDetector objects. You can inject custom schemas to the grid to define the classnames applied. + * An array of custom {@link EuiDataGridSchemaDetector} objects. You can inject custom schemas to the grid to define the classnames applied. */ schemaDetectors?: EuiDataGridSchemaDetector[]; /** @@ -269,7 +269,7 @@ export type CommonGridProps = CommonProps & rowCount: number; /** * A function called to render a cell's value. Behind the scenes it is treated as a React component - * allowing hooks, context, and other React concepts to be used. The function receives #EuiDataGridCellValueElementProps + * allowing hooks, context, and other React concepts to be used. The function receives {@link EuiDataGridCellValueElementProps} * as its only argument. */ renderCellValue: EuiDataGridCellProps['renderCellValue']; @@ -286,7 +286,7 @@ export type CommonGridProps = CommonProps & * `` around the cell actions. * * Behind the scenes it is treated as a React component allowing hooks, context, and other React concepts to be used. - * The function receives #EuiDataGridCellPopoverElementProps as its only argument. + * The function receives {@link EuiDataGridCellPopoverElementProps} as its only argument. * */ renderCellPopover?: EuiDataGridCellProps['renderCellPopover']; @@ -294,7 +294,7 @@ export type CommonGridProps = CommonProps & * An optional function called to render a footer cell. If not specified, no footer row is rendered. * * Behind the scenes it is treated as a React component - * allowing hooks, context, and other React concepts to be used. The function receives #EuiDataGridCellValueElementProps + * allowing hooks, context, and other React concepts to be used. The function receives {@link EuiDataGridCellValueElementProps} * as its only argument. */ renderFooterCellValue?: EuiDataGridCellProps['renderCellValue']; @@ -307,7 +307,7 @@ export type CommonGridProps = CommonProps & * * Behind the scenes, this function is treated as a React component, * allowing hooks, context, and other React concepts to be used. - * It receives #EuiDataGridCustomBodyProps as its only argument. + * It receives {@link EuiDataGridCustomBodyProps} as its only argument. */ renderCustomGridBody?: (args: EuiDataGridCustomBodyProps) => ReactNode; /** @@ -316,34 +316,34 @@ export type CommonGridProps = CommonProps & * * Behind the scenes, this function is treated as a React component, * allowing hooks, context, and other React concepts to be used. - * It receives #EuiDataGridCustomToolbarProps as its only argument. + * It receives {@link EuiDataGridCustomToolbarProps} as its only argument. */ renderCustomToolbar?: EuiDataGridToolbarProps['renderCustomToolbar']; /** - * Defines the initial style of the grid. Accepts a partial #EuiDataGridStyle object. + * Defines the initial style of the grid. Accepts a partial {@link EuiDataGridStyle} object. * Settings provided may be overwritten or merged with user defined preferences if `toolbarVisibility.showDisplaySelector.allowDensity = true` (which is the default). */ gridStyle?: EuiDataGridStyle; /** * Allows you to configure what features the toolbar shows. * - * Accepts either a boolean or #EuiDataGridToolBarVisibilityOptions object. + * Accepts either a boolean or {@link EuiDataGridToolBarVisibilityOptions} object. * When used as a boolean, defines the display of the entire toolbar. * When passed an object allows you to turn off individual controls within the toolbar as well as add additional buttons. */ toolbarVisibility?: boolean | EuiDataGridToolBarVisibilityOptions; /** - * A #EuiDataGridInMemory object to define the level of high order schema-detection and sorting logic to use on your data. + * A {@link EuiDataGridInMemory} object to define the level of high order schema-detection and sorting logic to use on your data. * **Try to set when possible**. * If omitted, disables all enhancements and assumes content is flat strings. */ inMemory?: EuiDataGridInMemory; /** - * A #EuiDataGridPaginationProps object. Omit to disable pagination completely. + * A {@link EuiDataGridPaginationProps} object. Omit to disable pagination completely. */ pagination?: EuiDataGridPaginationProps; /** - * A #EuiDataGridSorting object that provides the sorted columns along with their direction. Provides a callback for when it changes. + * A {@link EuiDataGridSorting} object that provides the sorted columns along with their direction. Provides a callback for when it changes. * Optional, but required when inMemory is set. * Omit to disable, but you'll likely want to also turn off the user sorting controls through the `toolbarVisibility` prop. */ @@ -384,7 +384,7 @@ export type CommonGridProps = CommonProps & | 'outerElementType' >; /** - * A #EuiDataGridRowHeightsOptions object that provides row heights options. + * A {@link EuiDataGridRowHeightsOptions} object that provides row heights options. * Allows configuring both default and specific heights of grid rows. * Settings provided may be overwritten or merged with user defined preferences if `toolbarVisibility.showDisplaySelector.allowRowHeight = true` (which is the default). */ @@ -558,7 +558,7 @@ interface SharedRenderCellElementProps { */ colIndex: number; /** - * ID of the column being rendered, the value comes from the #EuiDataGridColumn `id` + * ID of the column being rendered, the value comes from the {@link EuiDataGridColumn} `id` */ columnId: string; /** @@ -583,7 +583,7 @@ export interface EuiDataGridCellValueElementProps */ setCellProps: (props: EuiDataGridSetCellProps) => void; /** - * Whether or not the cell is expandable, comes from the #EuiDataGridColumn `isExpandable` which defaults to `true` + * Whether or not the cell is expandable, comes from the {@link EuiDataGridColumn} `isExpandable` which defaults to `true` */ isExpandable: boolean; /** @@ -752,12 +752,12 @@ export interface EuiDataGridColumn { defaultSortDirection?: 'asc' | 'desc'; /** * A Schema to use for the column. - * Built-in values are [`boolean`, `currency`, `datetime`, `numeric`, `json`] but can be expanded by defining your own #EuiDataGrid `schemaDetectors` (for in-memory detection). + * Built-in values are [`boolean`, `currency`, `datetime`, `numeric`, `json`] but can be expanded by defining your own {@link EuiDataGrid} `schemaDetectors` (for in-memory detection). * In general, it is advised to pass in a value here when you are sure of the schema ahead of time, so that you don't need to rely on the automatic detection. */ schema?: string; /** - * Configuration of column actions. Set to false to disable or use #EuiDataGridColumnActions to configure the actions displayed in the header cell of the column. + * Configuration of column actions. Set to false to disable or use {@link EuiDataGridColumnActions} to configure the actions displayed in the header cell of the column. */ actions?: false | EuiDataGridColumnActions; /** @@ -833,7 +833,7 @@ export interface EuiDataGridColumnCellActionProps { export interface EuiDataGridColumnVisibility { /** - * An array of #EuiDataGridColumn `id`s dictating the order and visibility of columns. + * An array of {@link EuiDataGridColumn} `id`s dictating the order and visibility of columns. */ visibleColumns: string[]; /** @@ -878,7 +878,7 @@ export interface EuiDataGridStyle { */ stripes?: boolean; /** - * Visual style for the column headers. Recommendation is to use the `underline` style in times when #EuiDataGrid `toolbarVisibility` is set to `false`. + * Visual style for the column headers. Recommendation is to use the `underline` style in times when {@link EuiDataGrid} `toolbarVisibility` is set to `false`. * @default shade */ header?: EuiDataGridStyleHeader; @@ -956,7 +956,7 @@ export type EuiDataGridDisplaySelectorCustomRender = ( export interface EuiDataGridToolBarVisibilityOptions { /** - * Allows the ability for the user to hide fields and sort columns, boolean or a #EuiDataGridToolBarVisibilityColumnSelectorOptions + * Allows the ability for the user to hide fields and sort columns, boolean or a {@link EuiDataGridToolBarVisibilityColumnSelectorOptions} * @default true */ showColumnSelector?: @@ -964,7 +964,7 @@ export interface EuiDataGridToolBarVisibilityOptions { | EuiDataGridToolBarVisibilityColumnSelectorOptions; /** * Allows the ability for the user to customize display settings such as grid density and row heights. - * User changes will override what is provided in #EuiDataGridStyle and #EuiDataGridRowHeightsOptions + * User changes will override what is provided in {@link EuiDataGridStyle} and {@link EuiDataGridRowHeightsOptions} * @default true */ showDisplaySelector?: @@ -988,7 +988,7 @@ export interface EuiDataGridToolBarVisibilityOptions { showFullScreenSelector?: boolean; /** * If passed a `ReactNode`, appends the passed custom control into the left side of the toolbar, after the column & sort controls. - * Or use #EuiDataGridToolBarAdditionalControlsOptions to customize the location of your control. + * Or use {@link EuiDataGridToolBarAdditionalControlsOptions} to customize the location of your control. */ additionalControls?: ReactNode | EuiDataGridToolBarAdditionalControlsOptions; } @@ -996,7 +996,7 @@ export interface EuiDataGridToolBarVisibilityOptions { export interface EuiDataGridToolBarAdditionalControlsOptions { /** * If passed a `ReactNode`, appends the passed node into the left side of the toolbar, **after** the column & sort controls. - * Or use #EuiDataGridToolBarAdditionalControlsLeftOptions to customize the location of your control. + * Or use {@link EuiDataGridToolBarAdditionalControlsLeftOptions} to customize the location of your control. * We recommend using `` to match the existing controls on the left. */ left?: ReactNode | EuiDataGridToolBarAdditionalControlsLeftOptions; @@ -1123,7 +1123,7 @@ export interface EuiDataGridRowHeightsOptions { * Defines the height for a specific row. It can be line count or just height. * * When using row height overrides, we strongly setting the `showDisplaySelector: allowRowHeight` - * toolbar control to `false` in #EuiDataGridToolBarVisibilityOptions + * toolbar control to `false` in {@link EuiDataGridToolBarVisibilityOptions} */ rowHeights?: Record; /** diff --git a/packages/eui/src/components/date_picker/super_date_picker/super_date_picker.tsx b/packages/eui/src/components/date_picker/super_date_picker/super_date_picker.tsx index b0aa0d1ab75..0317f29b5bb 100644 --- a/packages/eui/src/components/date_picker/super_date_picker/super_date_picker.tsx +++ b/packages/eui/src/components/date_picker/super_date_picker/super_date_picker.tsx @@ -204,11 +204,11 @@ export type EuiSuperDatePickerProps = CommonProps & { isQuickSelectOnly?: boolean; /** - * Props passed to the update button #EuiSuperUpdateButtonProps + * Props passed to the update button {@link EuiSuperUpdateButtonProps} */ updateButtonProps?: EuiSuperUpdateButtonProps; /** - * Props passed to the quick select button #EuiQuickSelectButtonProps + * Props passed to the quick select button {@link EuiQuickSelectButtonProps} */ quickSelectButtonProps?: EuiQuickSelectButtonProps; diff --git a/packages/eui/src/components/form/range/types.ts b/packages/eui/src/components/form/range/types.ts index bd4368fbc18..09034cf1aee 100644 --- a/packages/eui/src/components/form/range/types.ts +++ b/packages/eui/src/components/form/range/types.ts @@ -63,7 +63,7 @@ export interface _SharedRangeDataStructures { tickInterval?: number; /** * Create colored indicators for certain intervals. - * An array of #EuiRangeLevel objects + * An array of {@link EuiRangeLevel} objects */ levels?: EuiRangeLevel[]; } diff --git a/packages/eui/src/components/header/header.tsx b/packages/eui/src/components/header/header.tsx index 51365d9159b..4e4bdd9242b 100644 --- a/packages/eui/src/components/header/header.tsx +++ b/packages/eui/src/components/header/header.tsx @@ -33,16 +33,16 @@ type EuiHeaderSectionItemType = EuiHeaderSectionItemProps['children']; export interface EuiHeaderSections { /** - * An array of items that will be wrapped in a #EuiHeaderSectionItem + * An array of items that will be wrapped in a {@link EuiHeaderSectionItem} */ items?: EuiHeaderSectionItemType[]; /** - * Breadcrumbs in the header cannot be wrapped in a #EuiHeaderSection in order for truncation to work. + * Breadcrumbs in the header cannot be wrapped in a {@link EuiHeaderSection} in order for truncation to work. * Simply pass the array of EuiBreadcrumb objects */ breadcrumbs?: EuiBreadcrumb[]; /** - * Other props to pass to #EuiHeaderBreadcrumbs + * Other props to pass to {@link EuiHeaderBreadcrumbs} */ breadcrumbProps?: Omit; } @@ -56,9 +56,9 @@ const createHeaderSection = (sections: EuiHeaderSectionItemType[]) => { export type EuiHeaderProps = CommonProps & HTMLAttributes & { /** - * An array of objects to wrap in a #EuiHeaderSection. + * An array of objects to wrap in a {@link EuiHeaderSection}. * Each section is spaced using `space-between`. - * See #EuiHeaderSections for object details. + * See {@link EuiHeaderSections} for object details. * This prop disregards the prop `children` if both are passed. */ sections?: EuiHeaderSections[]; diff --git a/packages/eui/src/components/key_pad_menu/key_pad_menu.tsx b/packages/eui/src/components/key_pad_menu/key_pad_menu.tsx index 1f0e70cb283..e2b2e7383cb 100644 --- a/packages/eui/src/components/key_pad_menu/key_pad_menu.tsx +++ b/packages/eui/src/components/key_pad_menu/key_pad_menu.tsx @@ -43,7 +43,7 @@ export type EuiKeyPadMenuProps = CommonProps & HTMLAttributes & { /** * Renders the the group as a `fieldset`. - * Set to `true` to customize the labelling, or pass an #_EuiKeyPadMenuCheckableProps object to add a `legend` or `ariaLegend` + * Set to `true` to customize the labelling, or pass an {@link _EuiKeyPadMenuCheckableProps} object to add a `legend` or `ariaLegend` */ checkable?: _EuiKeyPadMenuCheckableProps | true; }; diff --git a/packages/eui/src/components/list_group/list_group.tsx b/packages/eui/src/components/list_group/list_group.tsx index 55cf426abbd..7604530a1e6 100644 --- a/packages/eui/src/components/list_group/list_group.tsx +++ b/packages/eui/src/components/list_group/list_group.tsx @@ -42,7 +42,7 @@ export type EuiListGroupProps = CommonProps & gutterSize?: EuiListGroupGutterSize; /** - * Items to display in this group. See #EuiListGroupItem + * Items to display in this group. See {@link EuiListGroupItem} */ listItems?: EuiListGroupItemProps[]; diff --git a/packages/eui/src/components/list_group/list_group_item.tsx b/packages/eui/src/components/list_group/list_group_item.tsx index c4ae085b2f5..e95a8eb609e 100644 --- a/packages/eui/src/components/list_group/list_group_item.tsx +++ b/packages/eui/src/components/list_group/list_group_item.tsx @@ -118,7 +118,7 @@ export type EuiListGroupItemProps = CommonProps & showToolTip?: boolean; /** - * An object of #EuiListGroupItemExtraAction props. + * An object of {@link EuiListGroupItemExtraAction} props. * Adds an `EuiButtonIcon` to the right side of the item; `iconType` is required; * pass `alwaysShow` if you don't want the default behavior of only showing on hover */ diff --git a/packages/eui/src/components/list_group/pinnable_list_group/pinnable_list_group.tsx b/packages/eui/src/components/list_group/pinnable_list_group/pinnable_list_group.tsx index ad9e296a29e..291365bc632 100644 --- a/packages/eui/src/components/list_group/pinnable_list_group/pinnable_list_group.tsx +++ b/packages/eui/src/components/list_group/pinnable_list_group/pinnable_list_group.tsx @@ -34,7 +34,7 @@ export interface EuiPinnableListGroupProps EuiListGroupProps { /** * Extends `EuiListGroupItemProps`, at the very least, expecting a `label`. - * See #EuiPinnableListGroupItemProps + * See {@link EuiPinnableListGroupItemProps} */ listItems: EuiPinnableListGroupItemProps[]; /** diff --git a/packages/eui/src/components/loading/loading_spinner.tsx b/packages/eui/src/components/loading/loading_spinner.tsx index 7e2de00e9ab..64351682ae0 100644 --- a/packages/eui/src/components/loading/loading_spinner.tsx +++ b/packages/eui/src/components/loading/loading_spinner.tsx @@ -32,7 +32,7 @@ export type EuiLoadingSpinnerProps = CommonProps & /** * Sets the color of the border and highlight. * Each key accepts any valid CSS color value as a `string` - * See #EuiLoadingSpinnerColor + * See {@link EuiLoadingSpinnerColor} */ color?: EuiLoadingSpinnerColor; }; diff --git a/packages/eui/src/components/markdown_editor/plugins/markdown_default_plugins/parsing_plugins.ts b/packages/eui/src/components/markdown_editor/plugins/markdown_default_plugins/parsing_plugins.ts index ab936b3fd08..702605927dd 100644 --- a/packages/eui/src/components/markdown_editor/plugins/markdown_default_plugins/parsing_plugins.ts +++ b/packages/eui/src/components/markdown_editor/plugins/markdown_default_plugins/parsing_plugins.ts @@ -45,7 +45,7 @@ export type DefaultParsingPluginsConfig = { emoji?: { emoticon?: boolean }; /** * Allows configuring the `allowRelative` and `allowProtocols` of - * #EuiMarkdownLinkValidatorOptions + * {@link EuiMarkdownLinkValidatorOptions} */ linkValidator?: EuiMarkdownLinkValidatorOptions; }; diff --git a/packages/eui/src/components/popover/popover.tsx b/packages/eui/src/components/popover/popover.tsx index 98ec7724aec..03baad6a9d2 100644 --- a/packages/eui/src/components/popover/popover.tsx +++ b/packages/eui/src/components/popover/popover.tsx @@ -141,7 +141,7 @@ export interface EuiPopoverProps extends PropsWithChildren, CommonProps { */ panelStyle?: CSSProperties; /** - * Object of props passed to EuiPanel. See #EuiPopoverPanelProps + * Object of props passed to EuiPanel. See {@link EuiPopoverPanelProps} */ panelProps?: Omit< EuiPopoverPanelProps, diff --git a/packages/eui/src/components/resizable_container/resizable_panel.tsx b/packages/eui/src/components/resizable_container/resizable_panel.tsx index 2b06901a5ee..b77d87bad6e 100644 --- a/packages/eui/src/components/resizable_container/resizable_panel.tsx +++ b/packages/eui/src/components/resizable_container/resizable_panel.tsx @@ -80,7 +80,7 @@ export interface EuiResizablePanelControls { deregister: (panelId: EuiResizablePanelController['id']) => void; }; /** - * #ToggleCollapseCallback + * See {@link ToggleCollapseCallback} */ onToggleCollapsed?: ToggleCollapseCallback; onToggleCollapsedInternal: ToggleCollapseCallback; diff --git a/packages/eui/src/components/responsive/hide_for.tsx b/packages/eui/src/components/responsive/hide_for.tsx index e756d902f10..92fbf1bab86 100644 --- a/packages/eui/src/components/responsive/hide_for.tsx +++ b/packages/eui/src/components/responsive/hide_for.tsx @@ -18,7 +18,7 @@ export interface EuiHideForProps { children: ReactNode; /** * List of all the responsive sizes to hide the children for. - * Array of #EuiBreakpointSize + * Array of {@link EuiBreakpointSize} */ sizes: EuiHideForBreakpoints[] | 'all' | 'none'; } diff --git a/packages/eui/src/components/responsive/show_for.tsx b/packages/eui/src/components/responsive/show_for.tsx index 318a3974d22..0ba21a4d05d 100644 --- a/packages/eui/src/components/responsive/show_for.tsx +++ b/packages/eui/src/components/responsive/show_for.tsx @@ -18,7 +18,7 @@ export interface EuiShowForProps { children: ReactNode; /** * List of all the responsive sizes to show the children for. - * Array of #EuiBreakpointSize + * Array of {@link EuiBreakpointSize} */ sizes: EuiShowForBreakpoints[] | 'all' | 'none'; } diff --git a/packages/eui/src/components/search_bar/filters/field_value_selection_filter.tsx b/packages/eui/src/components/search_bar/filters/field_value_selection_filter.tsx index 145ca8ecedc..cc51874508a 100644 --- a/packages/eui/src/components/search_bar/filters/field_value_selection_filter.tsx +++ b/packages/eui/src/components/search_bar/filters/field_value_selection_filter.tsx @@ -42,7 +42,7 @@ export interface FieldValueSelectionFilterConfigType { field?: string; name: string; /** - * See #FieldValueOptionType + * See {@link FieldValueOptionType} */ options: FieldValueOptionType[] | OptionsLoader; filterWith?: 'prefix' | 'includes' | OptionsFilter; diff --git a/packages/eui/src/components/search_bar/filters/field_value_toggle_group_filter.tsx b/packages/eui/src/components/search_bar/filters/field_value_toggle_group_filter.tsx index 255d6340131..6cc9c335238 100644 --- a/packages/eui/src/components/search_bar/filters/field_value_toggle_group_filter.tsx +++ b/packages/eui/src/components/search_bar/filters/field_value_toggle_group_filter.tsx @@ -22,7 +22,7 @@ export interface FieldValueToggleGroupFilterConfigType { type: 'field_value_toggle_group'; field: string; /** - * See #FieldValueToggleGroupFilterItemType + * See {@link FieldValueToggleGroupFilterItemType} */ items: FieldValueToggleGroupFilterItemType[]; available?: () => boolean; diff --git a/packages/eui/src/components/search_bar/search_bar.tsx b/packages/eui/src/components/search_bar/search_bar.tsx index 82703a7d739..ed4f5da1ba1 100644 --- a/packages/eui/src/components/search_bar/search_bar.tsx +++ b/packages/eui/src/components/search_bar/search_bar.tsx @@ -92,7 +92,7 @@ export interface EuiSearchBarProps extends CommonProps { }; /** - An array of search filters. See #SearchFilterConfig. + An array of search filters. See {@link SearchFilterConfig}. */ filters?: SearchFilterConfig[]; diff --git a/packages/eui/src/components/selectable/selectable.tsx b/packages/eui/src/components/selectable/selectable.tsx index a2148d57bf9..7c93385c6d8 100644 --- a/packages/eui/src/components/selectable/selectable.tsx +++ b/packages/eui/src/components/selectable/selectable.tsx @@ -65,15 +65,16 @@ export type EuiSelectableOptionMatcher = ( args: EuiSelectableOptionMatcherArgs ) => boolean; -// The `searchable` prop has significant implications for a11y. -// When present, we effectively change from adhering -// to the ARIA `listbox` spec (https://www.w3.org/TR/wai-aria-practices-1.2/#Listbox) -// to the ARIA `combobox` spec (https://www.w3.org/TR/wai-aria-practices-1.2/#combobox) -// and (re)implement all relevant attributes and keyboard interactions. -// Take note of logic that relies on `searchable` to ensure that any -// modifications remain in alignment. -// -// `searchProps` can only be specified when `searchable` is true +/** + * The `searchable` prop has significant implications for a11y. When present, we effectively change from adhering to the + * - ARIA `listbox` spec (@see https://www.w3.org/TR/wai-aria-practices-1.2/#Listbox) + * - ARIA `combobox` spec (@see https://www.w3.org/TR/wai-aria-practices-1.2/#combobox) + * + * and (re)implement all relevant attributes and keyboard interactions. + * Take note of logic that relies on `searchable` to ensure that any modifications remain in alignment. + * + * `searchProps` can only be specified when `searchable` is `true`. + */ export type EuiSelectableSearchableProps = ExclusiveUnion< { searchable: false; @@ -85,7 +86,7 @@ export type EuiSelectableSearchableProps = ExclusiveUnion< searchable: true; /** * Passes props down to the `EuiFieldSearch`. - * See #EuiSelectableSearchProps + * {@link EuiSelectableSearchProps} */ searchProps?: EuiSelectableSearchableSearchProps; } @@ -109,7 +110,7 @@ export type EuiSelectableProps = CommonProps & search: ReactElement | undefined ) => ReactNode; /** - * Array of EuiSelectableOption objects. See #EuiSelectableOption + * Array of EuiSelectableOption objects. See {@link EuiSelectableOption} */ options: Array>; /** @@ -149,7 +150,7 @@ export type EuiSelectableProps = CommonProps & */ height?: number | 'full'; /** - * See #EuiSelectableOptionsListProps + * See {@link EuiSelectableOptionsListPropsWithDefaults} */ listProps?: EuiSelectableOptionsListPropsWithDefaults; /** diff --git a/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide.tsx b/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide.tsx index ce78248e96d..21eafeb2ed9 100644 --- a/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide.tsx +++ b/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide.tsx @@ -43,8 +43,8 @@ export type EuiSelectableTemplateSitewideProps = Partial< Omit, 'options'> > & { /** - * Extends the typical #EuiSelectableTemplateSitewideOption with the addition of pre-composed elements - * such as `icon`, `avatar`and `meta` + * Extends the typical EuiSelectable {@link EuiSelectableTemplateSitewideOption} with the addition of pre-composed elements + * such as `icon`, `avatar` and `meta` */ options: EuiSelectableTemplateSitewideOption[]; /** diff --git a/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide_option.tsx b/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide_option.tsx index d287d537fd6..765101b2c8d 100644 --- a/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide_option.tsx +++ b/packages/eui/src/components/selectable/selectable_templates/selectable_template_sitewide_option.tsx @@ -58,7 +58,7 @@ export type EuiSelectableTemplateSitewideOption = { */ avatar?: EuiAvatarProps; /** - * An array of inline #EuiSelectableTemplateSitewideMetaData displayed beneath the label and separated by bullets. + * An array of inline {@link EuiSelectableTemplateSitewideMetaData} displayed beneath the label and separated by bullets. */ meta?: EuiSelectableTemplateSitewideMetaData[]; } & EuiSelectableOption; diff --git a/packages/eui/src/components/side_nav/side_nav.tsx b/packages/eui/src/components/side_nav/side_nav.tsx index d54d2bbac0a..33b34a49d3b 100644 --- a/packages/eui/src/components/side_nav/side_nav.tsx +++ b/packages/eui/src/components/side_nav/side_nav.tsx @@ -40,7 +40,7 @@ export type EuiSideNavProps = T & */ heading?: ReactNode; /** - * Adds a couple extra #EuiSideNavHeading props and extends the props of EuiTitle that wraps the `heading` + * Adds a couple extra {@link EuiSideNavHeading} props and extends the props of EuiTitle that wraps the `heading` */ headingProps?: Partial; /** @@ -61,7 +61,7 @@ export type EuiSideNavProps = T & */ mobileBreakpoints?: EuiBreakpointSize[]; /** - * An array of #EuiSideNavItem objects. Lists navigation menu items. + * An array of {@link EuiSideNavItem} objects. Lists navigation menu items. */ items: Array>; /** diff --git a/packages/eui/src/components/table/table_row_cell.tsx b/packages/eui/src/components/table/table_row_cell.tsx index 09c6a6103f4..b456e1ee242 100644 --- a/packages/eui/src/components/table/table_row_cell.tsx +++ b/packages/eui/src/components/table/table_row_cell.tsx @@ -102,7 +102,7 @@ export interface EuiTableRowCellProps extends EuiTableRowCellSharedPropsShape { isExpander?: boolean; /** * Mobile options for displaying differently at small screens; - * See #EuiTableRowCellMobileOptionsShape + * See {@link EuiTableRowCellMobileOptionsShape} */ mobileOptions?: EuiTableRowCellMobileOptionsShape; /** diff --git a/packages/eui/src/components/timeline/timeline.tsx b/packages/eui/src/components/timeline/timeline.tsx index 7665ab0334b..2ff4aa40f83 100644 --- a/packages/eui/src/components/timeline/timeline.tsx +++ b/packages/eui/src/components/timeline/timeline.tsx @@ -21,7 +21,7 @@ export interface EuiTimelineProps extends HTMLAttributes, CommonProps { /** - * List of timeline items to render. See #EuiTimelineItem + * List of timeline items to render. See {@link EuiTimelineItem} */ items?: EuiTimelineItemProps[]; /** diff --git a/packages/eui/typedoc.json b/packages/eui/typedoc.json new file mode 100644 index 00000000000..4af2aa9c539 --- /dev/null +++ b/packages/eui/typedoc.json @@ -0,0 +1,5 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["./src/index.ts"], + "exclude": ["**/node_modules/**"] +} \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 524688cc025..030f32bb14d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7083,7 +7083,8 @@ __metadata: react-docgen-typescript: "npm:^2.2.2" rimraf: "npm:^6.0.1" ts-node: "npm:^10.9.2" - typescript: "npm:~5.5.4" + typedoc: "npm:^0.28.3" + typescript: "npm:^5.8.3" languageName: unknown linkType: soft @@ -7127,6 +7128,7 @@ __metadata: react-is: "npm:^18.3.1" react-live: "patch:react-live@npm%3A4.1.7#~/.yarn/patches/react-live-npm-4.1.7-7b41625faa.patch" react-window: "npm:^1.8.10" + typedoc: "npm:^0.28.4" typescript: "npm:~5.5.4" peerDependencies: react: ^18.0.0 @@ -8059,6 +8061,19 @@ __metadata: languageName: node linkType: hard +"@gerrit0/mini-shiki@npm:^3.2.2": + version: 3.3.0 + resolution: "@gerrit0/mini-shiki@npm:3.3.0" + dependencies: + "@shikijs/engine-oniguruma": "npm:^3.3.0" + "@shikijs/langs": "npm:^3.3.0" + "@shikijs/themes": "npm:^3.3.0" + "@shikijs/types": "npm:^3.3.0" + "@shikijs/vscode-textmate": "npm:^10.0.2" + checksum: 10c0/3dcc2d4d315da858cb3958de2a1a90bd667adb5b3fd77c617a39d7bad5dede8a0fb69e312367a3531aae42043f52caebce92f8878d5abf39a9b4d617cb347889 + languageName: node + linkType: hard + "@hapi/address@npm:^4.1.0": version: 4.1.0 resolution: "@hapi/address@npm:4.1.0" @@ -9358,6 +9373,51 @@ __metadata: languageName: node linkType: hard +"@shikijs/engine-oniguruma@npm:^3.3.0": + version: 3.3.0 + resolution: "@shikijs/engine-oniguruma@npm:3.3.0" + dependencies: + "@shikijs/types": "npm:3.3.0" + "@shikijs/vscode-textmate": "npm:^10.0.2" + checksum: 10c0/60674fa7154cd55d335450e896ee7e3f942f7ef687c12281107e1a2e7a68c5e2f9e290344c9bb6fbbcfe411ab061d12bb833f7533d0b3942b9d81385a3d4888b + languageName: node + linkType: hard + +"@shikijs/langs@npm:^3.3.0": + version: 3.3.0 + resolution: "@shikijs/langs@npm:3.3.0" + dependencies: + "@shikijs/types": "npm:3.3.0" + checksum: 10c0/b5cde8f48cc860882561d5c63ab5e284c4d26c56fb49a4296903a9cbac8be25ef2bd6bd8f62d02672f2f82f53193a6c33e6f61e43ce3a200714f42b6d74c7bcb + languageName: node + linkType: hard + +"@shikijs/themes@npm:^3.3.0": + version: 3.3.0 + resolution: "@shikijs/themes@npm:3.3.0" + dependencies: + "@shikijs/types": "npm:3.3.0" + checksum: 10c0/cbb5a0a07aaf4448919dbe564a5d88a3771a82e3e45434b112d8395f4179062dc46b7d5441c8ead67a482321acc506bd85bb4e2419827d3483ada66845d6818f + languageName: node + linkType: hard + +"@shikijs/types@npm:3.3.0, @shikijs/types@npm:^3.3.0": + version: 3.3.0 + resolution: "@shikijs/types@npm:3.3.0" + dependencies: + "@shikijs/vscode-textmate": "npm:^10.0.2" + "@types/hast": "npm:^3.0.4" + checksum: 10c0/1b5205ec33bf17b88d389d8da58d20432a3de71b937d4bd5b4ace424bc5e6fe7c82514cfaf10b3d22e789137ce0b6fefc917e8b578aab354653c8d654cd83c94 + languageName: node + linkType: hard + +"@shikijs/vscode-textmate@npm:^10.0.2": + version: 10.0.2 + resolution: "@shikijs/vscode-textmate@npm:10.0.2" + checksum: 10c0/36b682d691088ec244de292dc8f91b808f95c89466af421cf84cbab92230f03c8348649c14b3251991b10ce632b0c715e416e992dd5f28ff3221dc2693fd9462 + languageName: node + linkType: hard + "@sideway/address@npm:^4.1.5": version: 4.1.5 resolution: "@sideway/address@npm:4.1.5" @@ -10854,7 +10914,7 @@ __metadata: languageName: node linkType: hard -"@types/hast@npm:^3.0.0": +"@types/hast@npm:^3.0.0, @types/hast@npm:^3.0.4": version: 3.0.4 resolution: "@types/hast@npm:3.0.4" dependencies: @@ -15375,7 +15435,7 @@ __metadata: languageName: node linkType: hard -"browserslist@npm:^4.24.0, browserslist@npm:^4.24.4": +"browserslist@npm:^4.24.0, browserslist@npm:^4.24.3, browserslist@npm:^4.24.4": version: 4.24.4 resolution: "browserslist@npm:4.24.4" dependencies: @@ -17529,7 +17589,7 @@ __metadata: languageName: node linkType: hard -"core-js-compat@npm:^3.38.0, core-js-compat@npm:^3.40.0": +"core-js-compat@npm:^3.38.0": version: 3.41.0 resolution: "core-js-compat@npm:3.41.0" dependencies: @@ -17538,6 +17598,15 @@ __metadata: languageName: node linkType: hard +"core-js-compat@npm:^3.40.0": + version: 3.40.0 + resolution: "core-js-compat@npm:3.40.0" + dependencies: + browserslist: "npm:^4.24.3" + checksum: 10c0/44f6e88726fe266a5be9581a79766800478a8d5c492885f2d4c2a4e2babd9b06bc1689d5340d3a61ae7332f990aff2e83b6203ff8773137a627cfedfbeefabeb + languageName: node + linkType: hard + "core-js-pure@npm:^3.30.2": version: 3.37.1 resolution: "core-js-pure@npm:3.37.1" @@ -27535,6 +27604,15 @@ __metadata: languageName: node linkType: hard +"linkify-it@npm:^5.0.0": + version: 5.0.0 + resolution: "linkify-it@npm:5.0.0" + dependencies: + uc.micro: "npm:^2.0.0" + checksum: 10c0/ff4abbcdfa2003472fc3eb4b8e60905ec97718e11e33cca52059919a4c80cc0e0c2a14d23e23d8c00e5402bc5a885cdba8ca053a11483ab3cc8b3c7a52f88e2d + languageName: node + linkType: hard + "listr2@npm:^3.8.3": version: 3.12.2 resolution: "listr2@npm:3.12.2" @@ -28292,6 +28370,22 @@ __metadata: languageName: node linkType: hard +"markdown-it@npm:^14.1.0": + version: 14.1.0 + resolution: "markdown-it@npm:14.1.0" + dependencies: + argparse: "npm:^2.0.1" + entities: "npm:^4.4.0" + linkify-it: "npm:^5.0.0" + mdurl: "npm:^2.0.0" + punycode.js: "npm:^2.3.1" + uc.micro: "npm:^2.1.0" + bin: + markdown-it: bin/markdown-it.mjs + checksum: 10c0/9a6bb444181d2db7016a4173ae56a95a62c84d4cbfb6916a399b11d3e6581bf1cc2e4e1d07a2f022ae72c25f56db90fbe1e529fca16fbf9541659dc53480d4b4 + languageName: node + linkType: hard + "markdown-table@npm:^2.0.0": version: 2.0.0 resolution: "markdown-table@npm:2.0.0" @@ -28651,6 +28745,13 @@ __metadata: languageName: node linkType: hard +"mdurl@npm:^2.0.0": + version: 2.0.0 + resolution: "mdurl@npm:2.0.0" + checksum: 10c0/633db522272f75ce4788440669137c77540d74a83e9015666a9557a152c02e245b192edc20bc90ae953bbab727503994a53b236b4d9c99bdaee594d0e7dd2ce0 + languageName: node + linkType: hard + "media-typer@npm:0.3.0": version: 0.3.0 resolution: "media-typer@npm:0.3.0" @@ -34117,6 +34218,13 @@ __metadata: languageName: node linkType: hard +"punycode.js@npm:^2.3.1": + version: 2.3.1 + resolution: "punycode.js@npm:2.3.1" + checksum: 10c0/1d12c1c0e06127fa5db56bd7fdf698daf9a78104456a6b67326877afc21feaa821257b171539caedd2f0524027fa38e67b13dd094159c8d70b6d26d2bea4dfdb + languageName: node + linkType: hard + "punycode@npm:1.3.2": version: 1.3.2 resolution: "punycode@npm:1.3.2" @@ -40027,6 +40135,40 @@ __metadata: languageName: node linkType: hard +"typedoc@npm:^0.28.3": + version: 0.28.3 + resolution: "typedoc@npm:0.28.3" + dependencies: + "@gerrit0/mini-shiki": "npm:^3.2.2" + lunr: "npm:^2.3.9" + markdown-it: "npm:^14.1.0" + minimatch: "npm:^9.0.5" + yaml: "npm:^2.7.1" + peerDependencies: + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x + bin: + typedoc: bin/typedoc + checksum: 10c0/05cd7c26de0d760743c99a2c00e03eb1500c4fd5d355e5f0c7f9d29d514cb21b1064e436f82add431413ca93ff8dcd4c062b06bfd04337e9a75a3a879147b7dc + languageName: node + linkType: hard + +"typedoc@npm:^0.28.4": + version: 0.28.4 + resolution: "typedoc@npm:0.28.4" + dependencies: + "@gerrit0/mini-shiki": "npm:^3.2.2" + lunr: "npm:^2.3.9" + markdown-it: "npm:^14.1.0" + minimatch: "npm:^9.0.5" + yaml: "npm:^2.7.1" + peerDependencies: + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x + bin: + typedoc: bin/typedoc + checksum: 10c0/5c7f4019da81e8b0869e4757b3d74c001dc021be381c5716a14212fbf63ad81bcfc470e040b7eac132603447c367019d5acab323d1b358b040979f1f56fe6393 + languageName: node + linkType: hard + "typescript@npm:4.5.3": version: 4.5.3 resolution: "typescript@npm:4.5.3" @@ -40141,6 +40283,13 @@ __metadata: languageName: node linkType: hard +"uc.micro@npm:^2.0.0, uc.micro@npm:^2.1.0": + version: 2.1.0 + resolution: "uc.micro@npm:2.1.0" + checksum: 10c0/8862eddb412dda76f15db8ad1c640ccc2f47cdf8252a4a30be908d535602c8d33f9855dfcccb8b8837855c1ce1eaa563f7fa7ebe3c98fd0794351aab9b9c55fa + languageName: node + linkType: hard + "uglify-js@npm:^3.6.0": version: 3.10.2 resolution: "uglify-js@npm:3.10.2" @@ -42501,6 +42650,15 @@ __metadata: languageName: node linkType: hard +"yaml@npm:^2.7.1": + version: 2.7.1 + resolution: "yaml@npm:2.7.1" + bin: + yaml: bin.mjs + checksum: 10c0/ee2126398ab7d1fdde566b4013b68e36930b9e6d8e68b6db356875c99614c10d678b6f45597a145ff6d63814961221fc305bf9242af8bf7450177f8a68537590 + languageName: node + linkType: hard + "yargs-parser@npm:^10.0.0": version: 10.1.0 resolution: "yargs-parser@npm:10.1.0"