Replace infoButton to showInfoButton and improve JSDOC| Fixes liferay…

…#481
kienD · Feb 21, 2018 · 0121718 · 0121718
1 parent 44135e7
commit 0121718
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/packages/clay-management-toolbar/demos/a11y.html b/packages/clay-management-toolbar/demos/a11y.html
@@ -123,10 +123,10 @@ <h4>Without Search</h4>
 		new metal.ClayManagementToolbar({
 			creationMenu: true,
 			filterItems: filterItems,
-			infoButton: true,
 			searchFormName: 'mySearchName',
 			searchInputName: 'mySearchInputName',
 			selectable: true,
+			showInfoButton: true,
 			sortingOrder: 'asc',
 			spritemap: spritemap,
 			viewTypes: viewTypes,

diff --git a/packages/clay-management-toolbar/demos/index.html b/packages/clay-management-toolbar/demos/index.html
@@ -196,10 +196,10 @@ <h4>Without Search</h4>
 		new metal.ClayManagementToolbar({
 			creationMenu: true,
 			filterItems: filterItems,
-			infoButton: true,
 			searchFormName: 'mySearchName',
 			searchInputName: 'mySearchInputName',
 			selectable: true,
+			showInfoButton: true,
 			sortingOrder: 'asc',
 			spritemap: spritemap,
 			viewTypes: viewTypes,

diff --git a/packages/clay-management-toolbar/src/ClayManagementToolbar.js b/packages/clay-management-toolbar/src/ClayManagementToolbar.js
@@ -248,15 +248,6 @@ ClayManagementToolbar.STATE = {
 	 */
 	id: Config.string(),
 
-	/**
-	 * Flag to indicate if the Info button is needed.
-	 * @instance
-	 * @memberof ClayManagementToolbar
-	 * @type {?bool}
-	 * @default false
-	 */
-	infoButton: Config.bool().value(false),
-
 	/**
 	 * URL of the search form action
 	 * @instance
@@ -303,6 +294,15 @@ ClayManagementToolbar.STATE = {
 	 */
 	selectedItems: Config.number(),
 
+	/**
+	 * Flag to indicate if the Info button should be shown or not.
+	 * @instance
+	 * @memberof ClayManagementToolbar
+	 * @type {?bool}
+	 * @default false
+	 */
+	showInfoButton: Config.bool().value(false),
+
 	/**
 	 * Flag to indicate if search should be shown or not.
 	 * @instance

diff --git a/packages/clay-management-toolbar/src/ClayManagementToolbar.soy b/packages/clay-management-toolbar/src/ClayManagementToolbar.soy
@@ -54,12 +54,12 @@
 	]>}
 	{@param? hideFiltersDoneButton: bool}
 	{@param? id: string}
-	{@param? infoButton: bool}
 	{@param? searchActionURL: string}
 	{@param? searchFormName: string}
 	{@param? searchInputName: string}
 	{@param? selectable: bool}
 	{@param? selectedItems: number}
+	{@param? showInfoButton: bool}
 	{@param? showSearch: bool}
 	{@param? sortingOrder: string}
 	{@param? totalItems: number}
@@ -103,11 +103,11 @@
 			{param filterItems: $filterItems /}
 			{param hideFiltersDoneButton: $hideFiltersDoneButton /}
 			{param id: $id /}
-			{param infoButton: $infoButton /}
 			{param searchActionURL: $searchActionURL /}
 			{param searchFormName: $searchFormName /}
 			{param searchInputName: $searchInputName /}
 			{param selectable: $selectable /}
+			{param showInfoButton: $showInfoButton /}
 			{param showSearch: $showSearch != false /}
 			{param sortingOrder: $sortingOrder /}
 			{param spritemap: $spritemap /}
@@ -263,11 +263,11 @@
 	]>}
 	{@param? hideFiltersDoneButton: bool}
 	{@param? id: string}
-	{@param? infoButton: bool}
 	{@param? searchActionURL: string}
 	{@param? searchFormName: string}
 	{@param? searchInputName: string}
 	{@param? selectable: bool}
+	{@param? showInfoButton: bool}
 	{@param? showSearch: bool}
 	{@param? sortingOrder: string}
 	{@param? viewTypes: list<[
@@ -394,7 +394,7 @@
 					</li>
 				{/if}
 
-				{if $infoButton}
+				{if $showInfoButton}
 					<li class="nav-item">
 						{call ClayButton.render}
 							{param elementClasses: 'nav-link nav-link-monospaced' /}

diff --git a/packages/clay-management-toolbar/src/__tests__/ClayManagementToolbar.js b/packages/clay-management-toolbar/src/__tests__/ClayManagementToolbar.js
@@ -372,7 +372,7 @@ describe('ClayManagementToolbar', function() {
 	it('should render a management toolbar with info button', () => {
 		managementToolbar = new ClayManagementToolbar({
 			spritemap: spritemap,
-			infoButton: true,
+			showInfoButton: true,
 		});
 
 		expect(managementToolbar).toMatchSnapshot();
@@ -629,7 +629,7 @@ describe('ClayManagementToolbar', function() {
 	it('should render a management toolbar with info button and emit an event on infoButton click', () => {
 		managementToolbar = new ClayManagementToolbar({
 			spritemap: spritemap,
-			infoButton: true,
+			showInfoButton: true,
 		});
 
 		const spy = jest.spyOn(managementToolbar, 'emit');