Skip to content
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

Change the default value of actionItems to [] | Fixes #1178 #1181

Merged
merged 9 commits into from
Sep 18, 2018
Merged

Change the default value of actionItems to [] | Fixes #1178 #1181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9c1b545
Change the default value of actionItems to [] | Fixes #1178
matuzalemsteles Sep 12, 2018
dedf493
Add tests | Fixes #1178
matuzalemsteles Sep 12, 2018
3cd466d
Change the default value of actionItems to [] in DatasetDisplay | Fix…
matuzalemsteles Sep 12, 2018
c69a095
SF | Fixes #1178
matuzalemsteles Sep 12, 2018
ca4abea
Changing the type of actionItems | Fixes #1178
matuzalemsteles Sep 12, 2018
ac5f1f9
Remove the default value of actionItems in Soy from DatasetDisplay | …
matuzalemsteles Sep 12, 2018
ae41b29
Typo | Fixes #1178
matuzalemsteles Sep 17, 2018
9f45c07
Adds demo with active state with no actions | Fixes #1178
matuzalemsteles Sep 17, 2018
7551b99
Regen snapshots | Fixes #1178
matuzalemsteles Sep 17, 2018
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
2 changes: 1 addition & 1 deletion packages/clay-dataset-display/src/ClayDatasetDisplay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ ClayDatasetDisplay.STATE = {

/**
* List of items to display in the management toolbar actions menu.
* @default undefined
* @default []
* @instance
* @memberof ClayDatasetDisplay
* @type {?(array|undefined)}
Expand Down
18 changes: 18 additions & 0 deletions packages/clay-management-toolbar/demos/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ <h2>Active State</h2>
</div>
</div>

<div class="row row-spacing">
<div class="col">
<h2>Active State with no actions</h2>
<div id="active-no-actions-block"></div>
</div>
</div>

<div class="row row-spacing">
<div class="col">
<h2>Disabled State</h2>
Expand Down Expand Up @@ -315,6 +322,17 @@ <h4>With filter labels</h4>
},
'#active-block');

// Active state no actions
new metal.ClayManagementToolbar({
actionItems: [],
selectable: true,
selectedItems: 5,
showInfoButton: true,
spritemap: spritemap,
totalItems: 10,
},
'#active-no-actions-block');

//Disabled State
new metal.ClayManagementToolbar({
creationMenu: {
Expand Down
2 changes: 1 addition & 1 deletion packages/clay-management-toolbar/src/ClayManagementToolbar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ ClayManagementToolbar.STATE = {

/**
* List of items to display in the actions menu on active state.
* @default undefined
* @default []
* @instance
* @memberof ClayManagementToolbar
* @type {?(array|undefined)}
Expand Down
18 changes: 6 additions & 12 deletions packages/clay-management-toolbar/src/ClayManagementToolbar.soy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
{param _handleInfoButtonClicked: $_handleInfoButtonClicked /}
{param _handleQuickActionClicked: $_handleQuickActionClicked /}
{param _handleSelectPageCheckboxChanged: $_handleSelectPageCheckboxChanged /}
{param actionItems: $actionItems /}
{param actionItems: $actionItems ?: [] /}
{param selectedItems: $selectedItems /}
{param showInfoButton: $showInfoButton /}
{param spritemap: $spritemap /}
Expand Down Expand Up @@ -200,20 +200,12 @@
* This renders the component's active content.
*/
{template .active}
{@param actionItems: list<?>}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @jbalsas, I'm removing the typing here so that at https://github.com/liferay/clay/pull/1181/files#diff-54445d58e09b53d03b6d0558828824f6R136 can set the default value if not passed.

Since we are typing actionItems above, we can ensure that the values are passed correctly.

{@param spritemap: string}
{@param? _handleActionItemClicked: any}
{@param? _handleInfoButtonClicked: any}
{@param? _handleQuickActionClicked: any}
{@param? _handleSelectPageCheckboxChanged: any}
{@param? actionItems: list<[
disabled: bool,
href: string,
icon: string,
label: string,
quickAction: bool,
separator: bool,
type: string
]>}
{@param? selectedItems: number}
{@param? showInfoButton: bool}
{@param? totalItems: number}
Expand Down Expand Up @@ -251,7 +243,9 @@
</li>
</ul>

{if $actionItems or $showInfoButton}
{let $hasActionItems: length($actionItems) > 0 /}

{if $hasActionItems or $showInfoButton}
<ul class="navbar-nav">
{if $showInfoButton}
<li class="nav-item">
Expand All @@ -271,7 +265,7 @@
</li>
{/if}

{if $actionItems}
{if $hasActionItems}
{foreach $item in $actionItems}
{if $item.quickAction and $item.icon and $spritemap}
<li class="nav-item navbar-breakpoint-down-d-none" data-quick-action-index="{index($item)}" data-onclick="{$_handleQuickActionClicked}">
Expand Down
12 changes: 12 additions & 0 deletions packages/clay-management-toolbar/src/__tests__/ClayManagementToolbar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,18 @@ describe('ClayManagementToolbar', function() {
expect(managementToolbar).toMatchSnapshot();
});

it('should render a management toolbar with no actions when actionsItems is empty in active state', () => {
managementToolbar = new ClayManagementToolbar({
actionItems: [],
selectable: true,
selectedItems: 1,
spritemap: spritemap,
totalItems: 10,
});

expect(managementToolbar).toMatchSnapshot();
});

it('should render a management toolbar with actions as quick actions in active state', () => {
managementToolbar = new ClayManagementToolbar({
actionItems: [
Expand Down
26 changes: 26 additions & 0 deletions packages/clay-management-toolbar/src/__tests__/__snapshots__/ClayManagementToolbar.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1783,6 +1783,32 @@ exports[`ClayManagementToolbar should render a management toolbar with links as
</div>
`;

exports[`ClayManagementToolbar should render a management toolbar with no actions when actionsItems is empty in active state 1`] = `
<div>
<nav class="management-bar management-bar-primary navbar navbar-expand-md navbar-nowrap">
<div class="container-fluid container-fluid-max-xl">
<ul class="navbar-nav navbar-nav-expand">
<li class="nav-item">
<div class="custom-control custom-checkbox">
<label>
<input checked="" class="custom-control-input" ref="input" type="checkbox">
<span class="custom-control-label">
<span class="custom-control-label-text sr-only">select-items</span>
</span>
</label>
</div>
</li>
<li class="nav-item">
<span class="navbar-text">1-of-10
<span class="navbar-breakpoint-down-d-none">items-selected</span>
</span>
</li>
</ul>
</div>
</nav>
</div>
`;

exports[`ClayManagementToolbar should render a management toolbar with no search 1`] = `
<div>
<nav class="management-bar management-bar-light navbar navbar-expand-md">
Expand Down
4 changes: 3 additions & 1 deletion packages/clay-management-toolbar/src/validators.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ let actionItemShape = {
type: Config.oneOf(['group', 'item']).value('item'),
};

const actionItemsValidator = Config.arrayOf(Config.shapeOf(actionItemShape));
const actionItemsValidator = Config.arrayOf(
Config.shapeOf(actionItemShape)
).value([]);

actionItemShape.items = actionItemsValidator;

Expand Down