OpenCloud
/
element-web
mirror of https://github.com/vector-im/element-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Clarifying documentation for setPhase

pull/28217/head
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.
*/