Skip to content

docs: add JSDoc comment to toolbarButtonReducer #3

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 1 commit into
base: master
Choose a base branch
from
Open

docs: add JSDoc comment to toolbarButtonReducer #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions src/toolbar/reducer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,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