@clayui/table 3.38.0 → 3.56.0

package/README.md

@@ -0,0 +1,19 @@
+# `@clayui/table`
+
+A table is a specific pattern for comparing datasets in a very direct and analytical way.
+
+-   [Documentation](https://clayui.com/docs/components/table.html)
+-   [Changelog](./CHANGELOG.md)
+-   [Breaking change schedule](./BREAKING.md)
+
+## Install
+
+Run `yarn`
+
+```shell
+yarn add @clayui/table
+```
+
+## Contribute
+
+We'd love to get contributions from you! Please, check our [Contributing Guidelines](https://github.com/liferay/clay/blob/master/CONTRIBUTING.md) to see how you can help us improve.

package/lib/Body.d.ts

@@ -1,3 +1,7 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 declare const ClayTableBody: React.ForwardRefExoticComponent<React.TableHTMLAttributes<HTMLTableSectionElement> & React.RefAttributes<HTMLTableSectionElement>>;
 export default ClayTableBody;

package/lib/Cell.d.ts

@@ -1,16 +1,46 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 import { TDelimiter } from './types';
 declare type ColumnTextAlignmentType = 'center' | 'end' | 'start';
 declare type TableCellBaseProps = React.ThHTMLAttributes<HTMLTableHeaderCellElement> & React.TdHTMLAttributes<HTMLTableDataCellElement>;
 declare type TextCellAlignmentType = 'center' | 'left' | 'right';
 export interface ICellProps extends TableCellBaseProps {
+    /**
+     * Aligns the text inside the Cell.
+     */
     align?: TextCellAlignmentType;
+    /**
+     * Sometimes we are unable to remove specific table columns from the DOM
+     * and need to hide it using CSS. This property can be added to the "new"
+     * first or last cell to maintain table styles on the left and right side.
+     */
     cellDelimiter?: TDelimiter;
+    /**
+     * Aligns horizontally contents inside the Cell.
+     */
     columnTextAlignment?: ColumnTextAlignmentType;
+    /**
+     * Fills out the remaining space inside a Cell.
+     */
     expanded?: boolean;
+    /**
+     * Defines the type of the Cell element, if true,
+     * cell element will be a `<th>`, otherwise `<td>`.
+     */
     headingCell?: boolean;
+    /**
+     * Applies a style of heading inside a child of table
+     * header cell element.
+     */
     headingTitle?: boolean;
     noWrap?: boolean;
+    /**
+     * Truncates the text inside a Cell. Requires `expanded`
+     * property value set to true.
+     */
     truncate?: boolean;
 }
 declare const ClayTableCell: React.ForwardRefExoticComponent<ICellProps & React.RefAttributes<HTMLTableDataCellElement | HTMLTableHeaderCellElement>>;

package/lib/Head.d.ts

@@ -1,3 +1,7 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 declare const ClayTableHead: React.ForwardRefExoticComponent<React.TableHTMLAttributes<HTMLTableSectionElement> & React.RefAttributes<HTMLTableSectionElement>>;
 export default ClayTableHead;

package/lib/Row.d.ts

@@ -1,8 +1,22 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 import { TDelimiter } from './types';
 export interface IRowProps extends React.HTMLAttributes<HTMLTableRowElement> {
+    /**
+     * Forces the active state inside the row.
+     */
     active?: boolean;
+    /**
+     * Applies a divider style inside the row.
+     */
     divider?: boolean;
+    /**
+     * This property can be added to the "new" first
+     * or last ClayTable.Row to maintain table styles on the top and bottom sides.
+     */
     rowDelimiter?: TDelimiter;
 }
 declare const ClayTableRow: React.ForwardRefExoticComponent<IRowProps & React.RefAttributes<HTMLTableRowElement>>;

package/lib/index.d.ts

@@ -1,17 +1,57 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 import React from 'react';
 declare type ResposiveSizeType = 'lg' | 'md' | 'sm' | 'xl';
 declare type VerticalAlignmentType = 'bottom' | 'middle' | 'top';
 interface IProps extends React.HTMLAttributes<HTMLTableElement> {
+    /**
+     * This property vertically align the contents
+     * inside the table body according a given position.
+     */
     bodyVerticalAlignment?: VerticalAlignmentType;
+    /**
+     * Applies a Bordered style on Table's columns.
+     */
     borderedColumns?: boolean;
+    /**
+     * Removes the default border and rounded corners from table.
+     */
     borderless?: boolean;
+    /**
+     * This property keeps all the headings on one line.
+     */
     headingNoWrap?: boolean;
+    /**
+     * This property vertically align the contents
+     * inside the table header according a given position.
+     */
     headVerticalAlignment?: VerticalAlignmentType;
+    /**
+     * Applies a Hover style on Table.
+     */
     hover?: boolean;
+    /**
+     * This property enables keeping everything on one line.
+     */
     noWrap?: boolean;
+    /**
+     * Turns the table responsive.
+     */
     responsive?: boolean;
+    /**
+     * Defines the responsive sizing.
+     */
     responsiveSize?: ResposiveSizeType;
+    /**
+     * Applies a Striped style on Table.
+     */
     striped?: boolean;
+    /**
+     * This property vertically align the contents
+     * inside the table according a given position.
+     */
     tableVerticalAlignment?: VerticalAlignmentType;
 }
 declare const _default: React.ForwardRefExoticComponent<IProps & React.RefAttributes<HTMLDivElement>> & {

package/lib/types.d.ts

@@ -1 +1,5 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
 export declare type TDelimiter = 'start' | 'end';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@clayui/table",
-	"version": "3.38.0",
+	"version": "3.56.0",
 	"description": "ClayTable 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": [
@@ -36,5 +36,5 @@
 	"browserslist": [
 		"extends browserslist-config-clay"
 	],
-	"gitHead": "7bd99c6d432b6973d76b7003e64ed72e42879a8b"
+	"gitHead": "1c33d9c709d8ce071862f0087c76ac23ce11465b"
 }

package/README.mdx

@@ -1,14 +0,0 @@
----
-title: 'Table'
-description: 'A table is a specific pattern for comparing datasets in a very direct and analytical way.'
-lexiconDefinition: 'https://liferay.design/lexicon/core-components/table/'
-packageNpm: '@clayui/table'
----
-
-import {Table} from '$packages/clay-table/docs/index';
-
-## Composing
-
-You compose the table with the main components to assemble a table with your use cases, use `ClayButton`, `ClayDropDown`... in the cells and try it out. We recommend that you review the [use cases in the Storybook](https://storybook.clayui.com/?path=/story/claytable--default).
-
-<Table />