API reference

The reference is generated from the package: the list of subpaths comes from its `exports`, the exported symbols and signatures from the declarations next to them. None of it is typed by hand.

34 subpaths in 3 families

Composables19

The behaviour the components are built from: focus, floating layers, keyboard, theme, toasts, virtual lists.

useAnnouncer@feugene/granularity/composables/useAnnouncer
- exports: 5
useComboboxNavigation@feugene/granularity/composables/useComboboxNavigation
- exports: 3
useDismissible@feugene/granularity/composables/useDismissible
- exports: 2
useDragGesture@feugene/granularity/composables/useDragGesture
- exports: 3
useDragSort@feugene/granularity/composables/useDragSort
- exports: 6
useFloating@feugene/granularity/composables/useFloating
- exports: 8
useFocusTrap@feugene/granularity/composables/useFocusTrap
- exports: 2
useGranularityTranslations@feugene/granularity/composables/useGranularityTranslations
- exports: 0
useGrComponentConfig@feugene/granularity/composables/useGrComponentConfig
- exports: 1
useGrFormControl@feugene/granularity/composables/useGrFormControl
- exports: 3
useHotkeys@feugene/granularity/composables/useHotkeys
- exports: 7
useOverlayLayer@feugene/granularity/composables/useOverlayLayer
- exports: 3
usePortalTarget@feugene/granularity/composables/usePortalTarget
- exports: 2
useRovingFocus@feugene/granularity/composables/useRovingFocus
- exports: 5
useScrollSpy@feugene/granularity/composables/useScrollSpy
- exports: 3
useTheme@feugene/granularity/composables/useTheme
- exports: 7
useToast@feugene/granularity/composables/useToast
- exports: 11
useTree@feugene/granularity/composables/useTree
- exports: 5
useVirtualList@feugene/granularity/composables/useVirtualList
- exports: 4

Directives7

Small behaviours on a plain element: autofocus, autosize, click outside, a drop zone, hotkeys, loading.

globalDirectives@feugene/granularity/directives/globalDirectives
- exports: 0
v-autofocus@feugene/granularity/directives/autofocus
- exports: 2
v-autosize@feugene/granularity/directives/autosize
- exports: 2
v-click-outside@feugene/granularity/directives/clickOutside
- exports: 4
v-dropzone@feugene/granularity/directives/dropzone
- exports: 3
v-hotkey@feugene/granularity/directives/hotkey
- exports: 6
v-loading@feugene/granularity/directives/loading
- exports: 6

Utilities8

Entry points outside the components: themes and tokens, translations, file validation, the Vue plugin, test helpers.

fileValidation@feugene/granularity/fileValidation
- exports: 0
granular-provider@feugene/granularity/granular-provider
- exports: 1
i18n@feugene/granularity/i18n
- exports: 0
testing@feugene/granularity/testing
- exports: 0
theme@feugene/granularity/theme
- exports: 0
theme/apply@feugene/granularity/theme/apply
- exports: 3
tokens@feugene/granularity/tokens
- exports: 0
vue@feugene/granularity/vue
- exports: 0

Source: @feugene/granularity 1.1.1, package.json#exports and dist/types