Skip to content

Commit edb8532

Browse files
committed
docs(api): fix link formatting with generic types
1 parent a4ee80e commit edb8532

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

packages/api-generator/src/types.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,18 +319,21 @@ const allowedRefs = [
319319
'FilterFunction',
320320
'FormValidationResult',
321321
'Group',
322+
'GroupSummary',
322323
'InternalDataTableHeader',
323324
'ListItem',
324325
'LocationStrategyFunction',
325326
'OpenSelectStrategyFunction',
326327
'OpenStrategy',
327328
'OpenStrategyFunction',
328329
'ScrollStrategyFunction',
330+
'SelectableItem',
329331
'SelectItemKey',
330332
'SelectStrategy',
331333
'SelectStrategyFunction',
332334
'SortItem',
333335
'SubmitEventPromise',
336+
'ItemKeySlot',
334337
'TemplateRef',
335338
'TouchHandlers',
336339
'ValidationRule',
@@ -349,7 +352,10 @@ const plainRefs = [
349352
'DataTableItem',
350353
'ListItem',
351354
'Group',
355+
'GroupSummary',
352356
'DataIteratorItem',
357+
'ItemKeySlot',
358+
'SelectItemKey',
353359
]
354360

355361
function formatDefinition (definition: Definition) {
@@ -397,6 +403,9 @@ function formatDefinition (definition: Definition) {
397403
} else {
398404
formatted = definition.text
399405
}
406+
if (allowedRefs.includes(definition.ref)) {
407+
formatted = `<a href="https://github.com/vuetifyjs/vuetify/blob/master/packages/${definition.source}" target="_blank">${formatted}</a>`
408+
}
400409
break
401410
case 'interface':
402411
case 'boolean':
@@ -409,10 +418,6 @@ function formatDefinition (definition: Definition) {
409418
}
410419

411420
definition.formatted = formatted
412-
413-
if (allowedRefs.includes(formatted)) {
414-
definition.formatted = `<a href="https://github.com/vuetifyjs/vuetify/blob/master/packages/${definition.source}" target="_blank">${formatted}</a>`
415-
}
416421
}
417422

418423
// eslint-disable-next-line complexity

packages/api-generator/src/utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ export function sortByKey (data: Record<string, any>) {
241241
export function stripLinks (str: string): [string, Record<string, string>] {
242242
let out = str.slice()
243243
const obj: Record<string, string> = {}
244-
const regexp = /<a.*?>(.*?)<\/a>/g
244+
const regexp = /<a .+?>(.+?)<\/a>/g
245245

246246
let matches = regexp.exec(str)
247247

packages/docs/src/components/api/utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export function stripLinks (str: string): [string, Record<string, string>] {
22
let out = str.slice()
33
const obj: Record<string, string> = {}
4-
const regexp = /<a.*?>(.*?)<\/a>/g
4+
const regexp = /<a .+?>(.+?)<\/a>/g
55

66
let matches = regexp.exec(str)
77

0 commit comments

Comments
 (0)