Skip to content

6789 - VS Code: Go-to-Definition for Global Vue Components #6790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
n-lark wants to merge 1 commit into
base: main
Choose a base branch
from
Open

6789 - VS Code: Go-to-Definition for Global Vue Components #6790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"parserOptions": {
"ecmaVersion": 2022
},
"ignorePatterns": ["frontend/dist/", "var/", "*.svg", "*.xml"],
"ignorePatterns": ["frontend/dist/", "var/", "*.svg", "*.xml", "**/*.d.ts"],
"plugins": ["promise", "no-only-tests"],
"settings": {
"import/core-modules": [ "lottie-web-vue", "@heroicons/vue" ],
Expand Down
7 changes: 7 additions & 0 deletions frontend/jsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"compilerOptions": {
"jsx": "preserve",
"baseUrl": "."
},
"include": ["src/**/*", "src/**/*.d.ts"]
}
54 changes: 54 additions & 0 deletions frontend/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Global component type declarations for Volar (Vue - Official) IDE support.
// Enables Go-to-Definition and autocomplete for globally registered components.
// Keep in sync with: ui-components/components.js and main.js

declare module 'vue' {
Copy link
Contributor

@cstns cstns Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big fan of manually declaring global components but it does the job. We'll just need to be mindful moving forward and keep this list in sync with any future global components

export interface GlobalComponents {
// -- ui-components/components.js --
FfNavBreadcrumb: typeof import('./ui-components/components/Breadcrumb.vue')['default']
FfButton: typeof import('./ui-components/components/Button.vue')['default']
FfCheck: typeof import('./ui-components/components/Check.vue')['default']
FfDialog: typeof import('./ui-components/components/DialogBox.vue')['default']
FfDivider: typeof import('./ui-components/components/Divider.vue')['default']
FfHelp: typeof import('./ui-components/components/Help.vue')['default']
FfMarkdownViewer: typeof import('./ui-components/components/Markdown.vue')['default']
FfNotificationPill: typeof import('./ui-components/components/NotificationPill.vue')['default']
FfNotificationToast: typeof import('./ui-components/components/NotificationToast.vue')['default']
FfPopover: typeof import('./ui-components/components/Popover.vue')['default']
FfSpinner: typeof import('./ui-components/components/Spinner.vue')['default']

// Data Table
FfDataTable: typeof import('./ui-components/components/data-table/DataTable.vue')['default']
FfDataTableCell: typeof import('./ui-components/components/data-table/DataTableCell.vue')['default']
FfDataTableRow: typeof import('./ui-components/components/data-table/DataTableRow.vue')['default']

// Form Elements
FfCheckbox: typeof import('./ui-components/components/form/Checkbox.vue')['default']
FfCombobox: typeof import('./ui-components/components/form/ComboBox.vue')['default']
FfDropdown: typeof import('./ui-components/components/form/Dropdown.vue')['default']
FfDropdownOption: typeof import('./ui-components/components/form/DropdownOption.vue')['default']
FfListbox: typeof import('./ui-components/components/form/ListBox.vue')['default']
FfRadioButton: typeof import('./ui-components/components/form/RadioButton.vue')['default']
FfRadioGroup: typeof import('./ui-components/components/form/RadioGroup.vue')['default']
FfTextInput: typeof import('./ui-components/components/form/TextInput.vue')['default']
FfTileSelection: typeof import('./ui-components/components/form/TileSelection.vue')['default']
FfTileSelectionOption: typeof import('./ui-components/components/form/TileSelectionOption.vue')['default']
FfToggleSwitch: typeof import('./ui-components/components/form/ToggleSwitch.vue')['default']

// Kebab Menu
FfKebabItem: typeof import('./ui-components/components/kebab-menu/KebabItem.vue')['default']
FfKebabMenu: typeof import('./ui-components/components/kebab-menu/KebabMenu.vue')['default']

// Tabs
FfTabs: typeof import('./ui-components/components/tabs/Tabs.vue')['default']

// -- main.js --
FfPage: typeof import('./layouts/Page.vue')['default']
FfPageHeader: typeof import('./components/SectionNavigationHeader.vue')['default']
FfLoading: typeof import('./components/Loading.vue')['default']
FfTeamLink: typeof import('./components/router-links/TeamLink.vue')['default']
LottieAnimation: typeof import('lottie-web-vue')['LottieAnimation']
}
}

export {}
Loading