mirrors/element-web
1
0
Fork 0
mirror of https://github.com/element-hq/element-web synced 2024-11-29 04:48:50 +03:00
Code Issues Projects Releases Packages Wiki Activity

Clarifying documentation for setPhase

Browse source
This commit is contained in:
Germain 2023-08-31 14:01:23 +01:00
parent 7836de77d0
commit 649e5202d4
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/utils/room/setPhase.ts
View file

@ -19,7 +19,11 @@ import { IRightPanelCardState } from "../../stores/right-panel/RightPanelStoreIP
import { RightPanelPhases } from "../../stores/right-panel/RightPanelStorePhases";
/**
* Helper to toggle a right panel view.
* Helper to show a right panel phase.
* If the UI is already showing that phase, the right panel will be hidden.
*
* Calling the same phase twice with a different state will update the current
* phase and push the old state in the right panel history.
* @param phase The right panel phase.
* @param cardState The state within the phase.
*/