arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 20:19:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(useOverlay): improve types and docs (#4012)

Browse Source 
Co-authored-by: Benjamin Canac <canacb1@gmail.com>
This commit is contained in:
Eugen Istoc
2025-04-29 12:09:39 -04:00
committed by GitHub
parent 195773ec7d
commit 39e29fccf1
3 changed files with 21 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/runtime/composables/useOverlay.ts
View File

@@ -21,12 +21,16 @@ interface ManagedOverlayOptionsPrivate<T extends Component> {
}
export type Overlay = OverlayOptions<Component> & ManagedOverlayOptionsPrivate<Component>
interface OverlayInstance<T extends Component> extends Omit<ManagedOverlayOptionsPrivate<T>, 'component'> {
type OverlayInstance<T extends Component> = Omit<ManagedOverlayOptionsPrivate<T>, 'component'> & {
id: symbol
result: Promise<CloseEventArgType<ComponentEmit<T>>>
open: (props?: ComponentProps<T>) => Omit<OverlayInstance<T>, 'open' | 'close' | 'patch' | 'modelValue' | 'resolvePromise'>
open: (props?: ComponentProps<T>) => OpenedOverlay<T>
close: (value?: any) => void
patch: (props: Partial<ComponentProps<T>>) => void
}
type OpenedOverlay<T extends Component> = Omit<OverlayInstance<T>, 'open' | 'close' | 'patch' | 'modelValue' | 'resolvePromise'> & {
result: Promise<CloseEventArgType<ComponentEmit<T>>>
}
function _useOverlay() {
@@ -48,14 +52,13 @@ function _useOverlay() {
return {
...options,
result: new Promise(() => {}),
open: <T extends Component>(props?: ComponentProps<T>) => open(options.id, props),
close: value => close(options.id, value),
patch: <T extends Component>(props: Partial<ComponentProps<T>>) => patch(options.id, props)
}
}
const open = <T extends Component>(id: symbol, props?: ComponentProps<T>) => {
const open = <T extends Component>(id: symbol, props?: ComponentProps<T>): OpenedOverlay<T> => {
const overlay = getOverlay(id)
// If props are provided, update the overlay's props
@@ -70,9 +73,7 @@ function _useOverlay() {
id,
isMounted: overlay.isMounted,
isOpen: overlay.isOpen,
result: new Promise<any>((resolve) => {
overlay.resolvePromise = resolve
})
result: new Promise<any>(resolve => overlay.resolvePromise = resolve)
}
}