Clarifying documentation for setPhase
This commit is contained in:
parent
7836de77d0
commit
649e5202d4
1 changed files with 5 additions and 1 deletions
|
@ -19,7 +19,11 @@ import { IRightPanelCardState } from "../../stores/right-panel/RightPanelStoreIP
|
||||||
import { RightPanelPhases } from "../../stores/right-panel/RightPanelStorePhases";
|
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 phase The right panel phase.
|
||||||
* @param cardState The state within the phase.
|
* @param cardState The state within the phase.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue