Rename ClayListGroup to ClayList

deprecate · Dec 11, 2017 · 64d1fe6 · 64d1fe6
1 parent b6f68cc
commit 64d1fe6
Show file tree

Hide file tree

Showing 14 changed files with 148 additions and 147 deletions.
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "jest": "jest",
     "lerna": "lerna bootstrap -- --no-optional --no-package-lock",
     "lint": "eslint packages/clay-*/src/*.js packages/clay-*/src/**/*.js && npm run mcritic",
-    "mcritic": "mcritic packages/ --ignore '**/{browserslist-config-clay-components,generator-metal-clay,clay-dropdown,clay-alert,clay-list-group,clay-management-toolbar,clay-card,node_modules}/**'",
+    "mcritic": "mcritic packages/ --ignore '**/{browserslist-config-clay-components,generator-metal-clay,clay-dropdown,clay-alert,clay-list,clay-management-toolbar,clay-card,node_modules}/**'",
     "precommit": "lint-staged",
     "prettier": "prettier-eslint packages/clay-*/src/*.js packages/clay-*/src/**/*.js",
     "start": "http-server . -p 4000",

diff --git a/packages/clay-list-group/LICENSE.md → packages/clay-list/LICENSE.md b/packages/clay-list-group/LICENSE.md → packages/clay-list/LICENSE.md
diff --git a/packages/clay-list-group/README.md → packages/clay-list/README.md b/packages/clay-list-group/README.md → packages/clay-list/README.md
@@ -1,6 +1,6 @@
-# clay-list-group
+# clay-list
 
-Clay ListGroup component
+Clay List component
 
 ## Setup
 

diff --git a/packages/clay-list-group/demos/index.html → packages/clay-list/demos/index.html b/packages/clay-list-group/demos/index.html → packages/clay-list/demos/index.html
@@ -3,7 +3,7 @@
 <head>
 	<meta charset="UTF-8">
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
-	<title>Demo: ClayListGroup</title>
+	<title>Demo: ClayList</title>
 
 	<link rel="stylesheet" href="../../../node_modules/clay/build/css/atlas.css">
 
@@ -17,86 +17,86 @@
 		}
 	</style>
 
-	<script src="../build/globals/clay-list-group.js"></script>
+	<script src="../build/globals/clay-list.js"></script>
 </head>
 <body class="container">
 	<div class="row row-spacing">
-		<h1>ListGroup</h1>
+		<h1>List</h1>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Simple ListGroup</h4>
+			<h4>Simple List</h4>
 			<div id="container1"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Simple ListGroup with links</h4>
+			<h4>Simple List with links</h4>
 			<div id="container2"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>ListGroup with description</h4>
+			<h4>List with description</h4>
 			<div id="container3"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup</h4>
+			<h4>Selectable List</h4>
 			<div id="container4"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Icon</h4>
+			<h4>Selectable List with Icon</h4>
 			<div id="container5"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Circle Icon</h4>
+			<h4>Selectable List with Circle Icon</h4>
 			<div id="container6"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Label</h4>
+			<h4>Selectable List with Label</h4>
 			<div id="container7"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Action Menu</h4>
+			<h4>Selectable List with Action Menu</h4>
 			<div id="container8"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Quick Action Menu</h4>
+			<h4>Selectable List with Quick Action Menu</h4>
 			<div id="container9"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Header Title</h4>
+			<h4>Selectable List with Header Title</h4>
 			<div id="container10"></div>
 		</div>
 	</div>
 
 	<div class="row row-spacing">
 		<div class="col">
-			<h4>Selectable ListGroup with Selected Items</h4>
+			<h4>Selectable List with Selected Items</h4>
 			<div id="container11"></div>
 		</div>
 	</div>
@@ -142,7 +142,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			},
 		];
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					title: 'Item 1',
@@ -156,7 +156,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			]
 		}, '#container1');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					title: 'Item 1',
@@ -173,7 +173,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			]
 		}, '#container2');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					description: 'Description 1',
@@ -193,7 +193,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			]
 		}, '#container3');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					description: 'Description 1',
@@ -214,7 +214,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			selectable: true,
 		}, '#container4');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					description: 'Description 1',
@@ -239,7 +239,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			spritemap: spritemap,
 		}, '#container5');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					description: 'Description 1',
@@ -267,7 +267,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			spritemap: spritemap,
 		}, '#container6');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					description: 'Description 1',
@@ -309,7 +309,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			spritemap: spritemap,
 		}, '#container7');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					actionItems: actionItems,
@@ -354,7 +354,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			spritemap: spritemap,
 		}, '#container8');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					actionItems: actionItemsWithQuickItems,
@@ -399,7 +399,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			spritemap: spritemap,
 		}, '#container9');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					actionItems: actionItemsWithQuickItems,
@@ -445,7 +445,7 @@ <h4>Selectable ListGroup with Selected Items</h4>
 			title: 'Group Header 1',
 		}, '#container10');
 
-		new metal.ClayListGroup({
+		new metal.ClayList({
 			items: [
 				{
 					actionItems: actionItems,

diff --git a/packages/clay-list-group/package.json → packages/clay-list/package.json b/packages/clay-list-group/package.json → packages/clay-list/package.json
@@ -1,16 +1,16 @@
 {
-  "name": "clay-list-group",
+  "name": "clay-list",
   "version": "1.0.0-alpha.8",
-  "description": "Metal ClayListGroup component",
+  "description": "Metal ClayList component",
   "license": "BSD",
   "repository": "https://github.com/metal/metal-clay-components/tree/master/packages/clay-list-group",
   "engines": {
     "node": ">=0.12.0",
     "npm": ">=3.0.0"
   },
-  "main": "lib/ClayListGroup.js",
-  "esnext:main": "src/ClayListGroup.js",
-  "jsnext:main": "src/ClayListGroup.js",
+  "main": "lib/ClayList.js",
+  "esnext:main": "src/ClayList.js",
+  "jsnext:main": "src/ClayList.js",
   "files": [
     "lib",
     "src",

diff --git a/...ages/clay-list-group/src/ClayListGroup.js → packages/clay-list/src/ClayList.js b/...ages/clay-list-group/src/ClayListGroup.js → packages/clay-list/src/ClayList.js
@@ -3,19 +3,19 @@ import 'clay-icon';
 import 'clay-label';
 import 'clay-link';
 import 'clay-sticker';
-import './ClayListGroupItem';
+import './ClayListItem';
 
 import Component from 'metal-component';
 import defineWebComponent from 'metal-web-component';
 import Soy from 'metal-soy';
 import {Config} from 'metal-state';
 
-import templates from './ClayListGroup.soy.js';
+import templates from './ClayList.soy.js';
 
 /**
- * Metal ClayListGroup component.
+ * Metal ClayList component.
  */
-class ClayListGroup extends Component {
+class ClayList extends Component {
 	/**
 	 * Continues the propagation of the checkbox changed event
 	 * @param {!Event} event
@@ -31,11 +31,11 @@ class ClayListGroup extends Component {
  * @static
  * @type {!Object}
  */
-ClayListGroup.STATE = {
+ClayList.STATE = {
 	/**
 	 * CSS classes to be applied to the element.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {?string|undefined}
 	 * @default undefined
 	 */
@@ -44,7 +44,7 @@ ClayListGroup.STATE = {
 	/**
 	 * Id to be applied to the element.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {?string|undefined}
 	 * @default undefined
 	 */
@@ -53,7 +53,7 @@ ClayListGroup.STATE = {
 	/**
 	 * List of items.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {!array}
 	 * @default undefined
 	 */
@@ -93,7 +93,7 @@ ClayListGroup.STATE = {
 	/**
 	 * Flag to indicate if the list group items are selectable.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {?bool|undefined}
 	 * @default false
 	 */
@@ -102,7 +102,7 @@ ClayListGroup.STATE = {
 	/**
 	 * The path to the SVG spritemap file containing the icons.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {?string|undefined}
 	 * @default undefined
 	 */
@@ -111,16 +111,16 @@ ClayListGroup.STATE = {
 	/**
 	 * Header of the list group.
 	 * @instance
-	 * @memberof ClayListGroup
+	 * @memberof ClayList
 	 * @type {?string|undefined}
 	 * @default undefined
 	 */
 	title: Config.string(),
 };
 
-defineWebComponent('clay-list-group', ClayListGroup);
+defineWebComponent('clay-list', ClayList);
 
-Soy.register(ClayListGroup, templates);
+Soy.register(ClayList, templates);
 
-export {ClayListGroup};
-export default ClayListGroup;
+export {ClayList};
+export default ClayList;
diff --git a/...ges/clay-list-group/src/ClayListGroup.soy → packages/clay-list/src/ClayList.soy b/...ges/clay-list-group/src/ClayListGroup.soy → packages/clay-list/src/ClayList.soy
@@ -1,4 +1,4 @@
-{namespace ClayListGroup}
+{namespace ClayList}
 
 /**
  * This renders the component's whole content.
@@ -51,7 +51,7 @@
 		{/if}
 
 		{foreach $item in $items}
-			{call ClayListGroupItem.render}
+			{call ClayListItem.render}
 				{param actionItems: $item.actionItems /}
 				{param description: $item.description /}
 				{param events: ['itemToggled': $handleItemToggled_ ] /}