Skip to content

Commit c4e18ff

Browse files
chore(eui): use link annotation in place of an anchor
1 parent 95bfcc3 commit c4e18ff

File tree

35 files changed

+98
-94
lines changed

35 files changed

+98
-94
lines changed

packages/eui-theme-common/src/global_styling/variables/typography.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export interface _EuiThemeTitle {
138138
export type _EuiThemeFont = _EuiThemeFontBase & {
139139
scale: _EuiThemeFontScales;
140140
/**
141-
* @see {@link https://eui.elastic.co/#/theming/typography/values%23font-weight | Reference} for more information
141+
* See {@link https://eui.elastic.co/#/theming/typography/values%23font-weight | Reference} for more information
142142
*/
143143
weight: _EuiThemeFontWeights;
144144
body: _EuiThemeBody;

packages/eui-theme-common/src/services/theme/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export type EuiThemeShape = {
6060
/** - Default value: 16 */
6161
base: _EuiThemeBase;
6262
/**
63-
* @see {@link https://eui.elastic.co/#/theming/sizing | Reference} for more information
63+
* See {@link https://eui.elastic.co/#/theming/sizing | Reference} for more information
6464
*/
6565
size: _EuiThemeSizes;
6666
font: _EuiThemeFont;

packages/eui/src/components/basic_table/basic_table.tsx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ interface BasicTableProps<T extends object>
227227
*/
228228
cellProps?: object | CellPropsCallback<T>;
229229
/**
230-
* An array of one of the objects: #EuiTableFieldDataColumnType, #EuiTableComputedColumnType or #EuiTableActionsColumnType.
230+
* An array of one of the objects: {@link EuiTableFieldDataColumnType}, {@link EuiTableComputedColumnType} or {@link EuiTableActionsColumnType}.
231231
*/
232232
columns: Array<EuiBasicTableColumn<T>>;
233233
/**
@@ -251,23 +251,24 @@ interface BasicTableProps<T extends object>
251251
*/
252252
noItemsMessage?: ReactNode;
253253
/**
254-
* Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured). See #Criteria or #CriteriaWithPagination
254+
* Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured).
255+
* {@link Criteria} or {@link CriteriaWithPagination}
255256
*/
256257
onChange?: (criteria: Criteria<T>) => void;
257258
/**
258-
* Configures #Pagination
259+
* Configures {@link Pagination}
259260
*/
260261
pagination?: undefined;
261262
/**
262263
* Applied to `EuiTableRow`
263264
*/
264265
rowProps?: object | RowPropsCallback<T>;
265266
/**
266-
* Configures #EuiTableSelectionType
267+
* Configures {@link EuiTableSelectionType}
267268
*/
268269
selection?: EuiTableSelectionType<T>;
269270
/**
270-
* Configures #EuiTableSortingType
271+
* Configures {@link EuiTableSortingType}
271272
*/
272273
sorting?: EuiTableSortingType<T>;
273274
/**

packages/eui/src/components/basic_table/in_memory_table.tsx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type InMemoryTableProps<T extends object> = Omit<
7777
> & {
7878
message?: ReactNode;
7979
/**
80-
* Configures #Search.
80+
* Configures {@link Search}.
8181
*/
8282
search?: Search;
8383
/**
@@ -93,11 +93,11 @@ type InMemoryTableProps<T extends object> = Omit<
9393
*/
9494
searchFormat?: 'eql' | 'text';
9595
/**
96-
* Configures #Pagination
96+
* Configures {@link Pagination}
9797
*/
9898
pagination?: undefined;
9999
/**
100-
* Configures #EuiTableSortingType
100+
* Configures {@link EuiTableSortingType}
101101
*/
102102
sorting?: Sorting;
103103
/**
@@ -107,11 +107,13 @@ type InMemoryTableProps<T extends object> = Omit<
107107
/**
108108
* `onChange` is not required when `pagination` and/or `sorting` are configured,
109109
* but if `onChange` is present it is responsible for handling state for each/both.
110-
* See #Criteria or #CriteriaWithPagination
110+
* {@link Criteria} or {@link CriteriaWithPagination}
111111
*/
112112
onChange?: EuiBasicTableProps<T>['onChange'];
113113
/**
114-
* 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.
114+
* Callback for when table pagination or sorting is changed. This is meant to be informational only,
115+
* and not used to set any state as the in-memory table already manages this state.
116+
* {@link Criteria} or {@link CriteriaWithPagination}.
115117
*/
116118
onTableChange?: (nextValues: Criteria<T>) => void;
117119
executeQueryOptions?: {

packages/eui/src/components/basic_table/table_types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ export type EuiTableComputedColumnType<T> = CommonProps &
163163

164164
export type EuiTableActionsColumnType<T extends object> = {
165165
/**
166-
* An array of one of the objects: #DefaultItemAction or #CustomItemAction
166+
* An array of one of the objects: {@link DefaultItemAction} or {@link CustomItemAction}
167167
*/
168168
actions: Array<Action<T>>;
169169
/**

packages/eui/src/components/breadcrumbs/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export type EuiBreadcrumbResponsiveMaxCount = {
3232
export type EuiBreadcrumbsProps = CommonProps & {
3333
/**
3434
* Hides extra (above the max) breadcrumbs under a collapsed item as the window gets smaller.
35-
* Pass a custom #EuiBreadcrumbResponsiveMaxCount object to change the number of breadcrumbs to show at the particular breakpoints.
35+
* Pass a custom {@link EuiBreadcrumbResponsiveMaxCount} object to change the number of breadcrumbs to show at the particular breakpoints.
3636
*
3737
* Pass `false` to turn this behavior off.
3838
*
@@ -55,7 +55,7 @@ export type EuiBreadcrumbsProps = CommonProps & {
5555
max?: number | null;
5656

5757
/**
58-
* The array of individual #EuiBreadcrumb items
58+
* The array of individual {@link EuiBreadcrumb} items
5959
*/
6060
breadcrumbs: EuiBreadcrumbProps[];
6161

packages/eui/src/components/button/button_group/button_group.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export type EuiButtonGroupProps = CommonProps & {
9595
*/
9696
type?: 'single' | 'multi';
9797
/**
98-
* An array of #EuiButtonGroupOptionProps
98+
* An array of {@link EuiButtonGroupOptionProps}
9999
*/
100100
options: EuiButtonGroupOptionProps[];
101101
} & (

packages/eui/src/components/collapsible_nav_beta/collapsible_nav_item/collapsible_nav_item.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export type EuiCollapsibleNavItemProps = _SharedEuiCollapsibleNavItemProps &
8888
/**
8989
* Will render either an accordion or group of nested child item links.
9090
*
91-
* Accepts any #EuiCollapsibleNavItemProps. Or, to render completely custom
91+
* Accepts any {@link EuiCollapsibleNavItemProps}. Or, to render completely custom
9292
* subitem content, pass an object with a `renderItem` callback.
9393
*/
9494
items: EuiCollapsibleNavSubItemProps[];

packages/eui/src/components/color_picker/color_palette_display/color_palette_display.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export type EuiColorPaletteDisplaySize = (typeof SIZES)[number];
2929

3030
export interface EuiColorPaletteDisplayShared {
3131
/**
32-
* Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range.
32+
* Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range.
3333
*/
3434
palette: string[] | PaletteColorStop[];
3535
}

packages/eui/src/components/color_picker/color_palette_picker/color_palette_picker.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface EuiColorPalettePickerPaletteTextProps extends CommonProps {
4747
*/
4848
type: 'text';
4949
/**
50-
* Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range.
50+
* Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range.
5151
*/
5252
palette?: string[] | PaletteColorStop[];
5353
}
@@ -70,7 +70,7 @@ export interface EuiColorPalettePickerPaletteFixedProps extends CommonProps {
7070
*/
7171
type: 'fixed';
7272
/**
73-
* Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range.
73+
* Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range.
7474
*/
7575
palette: string[] | PaletteColorStop[];
7676
}
@@ -93,7 +93,7 @@ export interface EuiColorPalettePickerPaletteGradientProps extends CommonProps {
9393
*/
9494
type: 'gradient';
9595
/**
96-
* Array of color `strings` or an array of #PaletteColorStop. The stops must be numbers in an ordered range.
96+
* Array of color `strings` or an array of {@link PaletteColorStop}. The stops must be numbers in an ordered range.
9797
*/
9898
palette: string[] | PaletteColorStop[];
9999
}
@@ -114,7 +114,7 @@ export type EuiColorPalettePickerProps<T extends string> = CommonProps &
114114
selectionDisplay?: 'palette' | 'title';
115115

116116
/**
117-
* An array of one of the following objects: #EuiColorPalettePickerPaletteText, #EuiColorPalettePickerPaletteFixed, #EuiColorPalettePickerPaletteGradient
117+
* An array of one of the following objects: {@link EuiColorPalettePickerPaletteText}, {@link EuiColorPalettePickerPaletteFixed}, {@link EuiColorPalettePickerPaletteGradient}
118118
*/
119119
palettes: EuiColorPalettePickerPaletteProps[];
120120
};

0 commit comments

Comments
 (0)