@surdeddd/bottom-sheet
GitHub
Breaking changes
Preparing search index...
react
BottomSheetHandle
Type Alias BottomSheetHandle<TId>
type
BottomSheetHandle
<
TId
extends
string
=
string
>
=
{
snapTo
:
(
id
:
TId
)
=>
Promise
<
void
>
;
open
:
(
id
?:
TId
)
=>
Promise
<
void
>
;
close
:
(
reason
?:
CloseReason
)
=>
Promise
<
void
>
;
expand
:
()
=>
Promise
<
void
>
;
collapse
:
()
=>
Promise
<
void
>
;
isTop
:
()
=>
boolean
;
depth
:
()
=>
number
;
setAllowed
:
(
ids
:
TId
[]
,
snap
?:
TId
)
=>
void
;
setSnapPoints
:
(
points
:
EngineOptions
[
"snapPoints"
]
,
allowed
?:
string
[]
,
)
=>
void
;
setScrim
:
(
opts
:
ScrimUpdate
)
=>
void
;
setScrimOverlay
:
(
opts
:
ScrimOverlayOptions
)
=>
()
=>
void
;
addAnchor
:
(
opts
:
AnchorOptions
)
=>
()
=>
void
;
setScrimStages
:
(
opts
:
ScrimStagesOptions
|
null
)
=>
()
=>
void
;
recompute
:
()
=>
void
;
state
:
EngineState
&
{
activeId
:
TId
}
;
getEngine
:
()
=>
BottomSheetEngine
|
null
;
}
Type Parameters
TId
extends
string
=
string
Index
Properties
snap
To
open
close
expand
collapse
is
Top
depth
set
Allowed
set
Snap
Points
set
Scrim
set
Scrim
Overlay
add
Anchor
set
Scrim
Stages
recompute
state
get
Engine
Properties
snap
To
snapTo
:
(
id
:
TId
)
=>
Promise
<
void
>
open
open
:
(
id
?:
TId
)
=>
Promise
<
void
>
close
close
:
(
reason
?:
CloseReason
)
=>
Promise
<
void
>
expand
expand
:
()
=>
Promise
<
void
>
collapse
collapse
:
()
=>
Promise
<
void
>
is
Top
isTop
:
()
=>
boolean
depth
depth
:
()
=>
number
set
Allowed
setAllowed
:
(
ids
:
TId
[]
,
snap
?:
TId
)
=>
void
set
Snap
Points
setSnapPoints
:
(
points
:
EngineOptions
[
"snapPoints"
]
,
allowed
?:
string
[]
)
=>
void
set
Scrim
setScrim
:
(
opts
:
ScrimUpdate
)
=>
void
set
Scrim
Overlay
setScrimOverlay
:
(
opts
:
ScrimOverlayOptions
)
=>
()
=>
void
add
Anchor
addAnchor
:
(
opts
:
AnchorOptions
)
=>
()
=>
void
set
Scrim
Stages
setScrimStages
:
(
opts
:
ScrimStagesOptions
|
null
)
=>
()
=>
void
recompute
recompute
:
()
=>
void
state
state
:
EngineState
&
{
activeId
:
TId
}
get
Engine
getEngine
:
()
=>
BottomSheetEngine
|
null
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
snap
To
open
close
expand
collapse
is
Top
depth
set
Allowed
set
Snap
Points
set
Scrim
set
Scrim
Overlay
add
Anchor
set
Scrim
Stages
recompute
state
get
Engine
GitHub
Breaking changes
@surdeddd/bottom-sheet
Loading...