Skip to content

docs: document toolbar button state shape in reducer #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yanas wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: document toolbar button state shape in reducer #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfa43a1
docs: document toolbar button state shape in reducer
Mar 11, 2026
63cc94a
docs: add JSDoc comment to toolbarButtonReducer
Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/toolbar/reducer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
import * as t from './actionTypes';

/**
* Each toolbar button in the state has the following shape:
* id {string} - unique identifier (e.g. "toolbar_button_mute")
* buttonClassName {string} - CSS classes for the default (un-toggled) state
* toggledClassName{string} - CSS classes when the button is toggled on (optional)
* buttonShortcut {string} - keyboard shortcut popover key (optional)
* i18nTextKey {string} - i18n key used to set the button's accessible text
* tooltipText {string} - human-readable tooltip
* toggled {boolean} - current toggle state; absence means non-toggleable
* disabled {boolean} - whether the button is currently disabled (optional)
* unreadMessages {number} - unread count badge, used by the chat button (optional)
*/
const initialState = [
{
id: "toolbar_button_mute",
Expand Down Expand Up @@ -73,6 +85,15 @@ const initialState = [
}
];

/**
* Sub-reducer for a single toolbar button. On CLICK_BUTTON, toggles the
* `toggled` flag if the action targets this button and the button supports
* toggling (i.e. `toggled` is defined). Returns the button unchanged otherwise.
*
* @param {Object} toolbarButton - A single button entry from the state array.
* @param {Object} action - The dispatched Redux action.
* @returns {Object} The next state for this button.
*/
const toolbarButtonReducer = (toolbarButton, action) => {
switch (action.type) {
case t.CLICK_BUTTON:
Expand Down
Loading