Subject of the issue/enhancement/features
The _button._isFullWidth option has a title and nothing else in either schema format. The title says "Make full width", but making the button full width is the least of what the option does — its main effect is to dock the button to the bottom of the window, and it also quietly overrides a setting the author has already chosen. None of that is visible to someone authoring a course.
Your environment
- Trickle 7.9.1 / Framework 5.56.2
- Not browser-specific — this is authoring-time schema text
Expected behaviour
Turning the option on tells the author what it will do: dock the button to the bottom of the window, and switch step locking on whether or not they asked for it.
Actual behaviour
The option has no description or help text anywhere, in either schema format. The only place its real behaviour is written down is the README, which says it positions the button fixed to the bottom of the window and forces _stepLocking._isEnabled to true.
So an author sees "Make full width", turns it on to get a wider button, and gets a docked bar plus step locking they did not ask for. The same is true of _stepLocking._isEnabled in the other direction — nothing there says the value can be overridden.
Suggested Fix
Two small text changes, no behaviour change:
- Retitle
_isFullWidth so it mentions docking rather than only width, and give it a description covering the docking and the forced step locking.
- Add a description to
_stepLocking._isEnabled noting it is forced on when Full Width is enabled.
#260 already did exactly this for _styleAfterClick, which now reads "Ignored when Full Width is true; the button is always hidden after completion to prevent stacked buttons". This is the same gap, one option over.
Renaming the key itself would be a breaking change and needs a migration, so this is deliberately titles and descriptions only.
Subject of the issue/enhancement/features
The
_button._isFullWidthoption has a title and nothing else in either schema format. The title says "Make full width", but making the button full width is the least of what the option does — its main effect is to dock the button to the bottom of the window, and it also quietly overrides a setting the author has already chosen. None of that is visible to someone authoring a course.Your environment
Expected behaviour
Turning the option on tells the author what it will do: dock the button to the bottom of the window, and switch step locking on whether or not they asked for it.
Actual behaviour
The option has no description or help text anywhere, in either schema format. The only place its real behaviour is written down is the README, which says it positions the button fixed to the bottom of the window and forces
_stepLocking._isEnabledtotrue.So an author sees "Make full width", turns it on to get a wider button, and gets a docked bar plus step locking they did not ask for. The same is true of
_stepLocking._isEnabledin the other direction — nothing there says the value can be overridden.Suggested Fix
Two small text changes, no behaviour change:
_isFullWidthso it mentions docking rather than only width, and give it a description covering the docking and the forced step locking._stepLocking._isEnablednoting it is forced on when Full Width is enabled.#260 already did exactly this for
_styleAfterClick, which now reads "Ignored when Full Width is true; the button is always hidden after completion to prevent stacked buttons". This is the same gap, one option over.Renaming the key itself would be a breaking change and needs a migration, so this is deliberately titles and descriptions only.