@clayui/breadcrumb 3.55.0 → 3.56.0

package/lib/Ellipsis.d.ts

@@ -1,7 +1,17 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 import Item from './Item';
 interface IEllipsisProps extends React.HTMLAttributes<HTMLLIElement> {
+    /**
+     * Property to define BreadcrumbEllipsis's items.
+     */
     items: Array<React.ComponentProps<typeof Item>>;
+    /**
+     * Path to the location of the spritemap resource.
+     */
     spritemap?: string;
 }
 declare const Ellipsis: React.FunctionComponent<IEllipsisProps>;

package/lib/Item.d.ts

@@ -1,8 +1,24 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 interface IItem extends React.HTMLAttributes<HTMLLIElement> {
+    /**
+     * Flag to indicate if the Breadcrumb item is active or not.
+     */
     active?: boolean;
+    /**
+     * This value is used to be the target of the link.
+     */
     href?: string;
+    /**
+     * Label of the Breadcrumb item
+     */
     label: string;
+    /**
+     * Callback for when a Breadcrumb item is clicked.
+     */
     onClick?: (event: React.SyntheticEvent) => void;
 }
 declare const Item: ({ active, href, label, onClick, ...otherProps }: IItem) => JSX.Element;

package/lib/index.d.ts

@@ -1,11 +1,28 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 import Item from './Item';
 declare type TItem = React.ComponentProps<typeof Item>;
 declare type TItems = Array<TItem>;
 interface IProps extends React.HTMLAttributes<HTMLOListElement> {
+    /**
+     * The number of Breadcrumb Items to show on each side of the active Breadcrumb Item before
+     * using an ellipsis dropdown.
+     */
     ellipsisBuffer?: number;
+    /**
+     * Use this property for defining `otherProps` that will be passed to ellipsis dropdown trigger.
+     */
     ellipsisProps?: Object;
+    /**
+     * Property to define Breadcrumb's items.
+     */
     items: TItems;
+    /**
+     * Path to the location of the spritemap resource.
+     */
     spritemap?: string;
 }
 declare const ClayBreadcrumb: React.FunctionComponent<IProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@clayui/breadcrumb",
-	"version": "3.55.0",
+	"version": "3.56.0",
 	"description": "ClayBreadcrumb component",
 	"license": "BSD-3-Clause",
 	"repository": "https://github.com/liferay/clay",
@@ -17,8 +17,8 @@
 	],
 	"scripts": {
 		"build": "cross-env NODE_ENV=production babel src --root-mode upward --out-dir lib --extensions .ts,.tsx",
-		"build:types": "cross-env NODE_ENV=production tsc --project ./tsconfig.declarations.json",
-		"prepublishOnly": "yarn build && yarn build:types",
+		"buildTypes": "cross-env NODE_ENV=production tsc --project ./tsconfig.declarations.json",
+		"prepublishOnly": "yarn build && yarn buildTypes",
 		"test": "jest --config ../../jest.config.js"
 	},
 	"keywords": [
@@ -26,11 +26,11 @@
 		"react"
 	],
 	"dependencies": {
-		"@clayui/button": "^3.40.0",
-		"@clayui/drop-down": "^3.55.0",
-		"@clayui/icon": "^3.40.0",
-		"@clayui/link": "^3.45.0",
-		"@clayui/shared": "^3.55.0",
+		"@clayui/button": "^3.56.0",
+		"@clayui/drop-down": "^3.56.0",
+		"@clayui/icon": "^3.56.0",
+		"@clayui/link": "^3.56.0",
+		"@clayui/shared": "^3.56.0",
 		"classnames": "^2.2.6",
 		"warning": "^4.0.3"
 	},
@@ -42,5 +42,5 @@
 	"browserslist": [
 		"extends browserslist-config-clay"
 	],
-	"gitHead": "5310f4650d453a3659b0bc73a5f098732168c9c1"
+	"gitHead": "1c33d9c709d8ce071862f0087c76ac23ce11465b"
 }