@clayui/tabs 3.55.0 → 3.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/Content.d.ts CHANGED
@@ -1,7 +1,20 @@
1
+ /**
2
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
3
+ * SPDX-License-Identifier: BSD-3-Clause
4
+ */
1
5
  import React from 'react';
2
6
  interface IProps extends React.HTMLAttributes<HTMLDivElement> {
7
+ /**
8
+ * Receives a number that indicates the `tabkey` to be rendered.
9
+ */
3
10
  activeIndex: number;
11
+ /**
12
+ * Children elements received from ClayTabs.Content component.
13
+ */
4
14
  children: Array<React.ReactElement>;
15
+ /**
16
+ * Flag to indicate if `fade` classname that applies an fading animation should be applied.
17
+ */
5
18
  fade?: boolean;
6
19
  }
7
20
  declare const Content: React.FunctionComponent<IProps>;
package/lib/Item.d.ts CHANGED
@@ -1,9 +1,28 @@
1
+ /**
2
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
3
+ * SPDX-License-Identifier: BSD-3-Clause
4
+ */
1
5
  import React from 'react';
2
6
  interface IProps extends Omit<React.HTMLAttributes<HTMLLIElement>, 'onClick'> {
7
+ /**
8
+ * Flag to indicate if the component is active or not.
9
+ */
3
10
  active?: boolean;
11
+ /**
12
+ * Flag to indicate if the TabPane is disabled.
13
+ */
4
14
  disabled?: boolean;
15
+ /**
16
+ * This value is used to be the target of the link.
17
+ */
5
18
  href?: string;
19
+ /**
20
+ * Props to be added to the item element that can be an anchor or a button.
21
+ */
6
22
  innerProps?: React.HTMLAttributes<HTMLAnchorElement | HTMLButtonElement>;
23
+ /**
24
+ * Callback to be used when clicking to a Tab Item.
25
+ */
7
26
  onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
8
27
  }
9
28
  declare const Item: React.ForwardRefExoticComponent<IProps & React.RefAttributes<any>>;
package/lib/TabPane.d.ts CHANGED
@@ -1,6 +1,16 @@
1
+ /**
2
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
3
+ * SPDX-License-Identifier: BSD-3-Clause
4
+ */
1
5
  import React from 'react';
2
6
  interface ITabPaneProps extends React.HTMLAttributes<HTMLDivElement> {
7
+ /**
8
+ * Flag to indicate if `active` classname should be applied
9
+ */
3
10
  active?: boolean;
11
+ /**
12
+ * Flag to indicate if `fade` classname that applies a fading animation should be applied.
13
+ */
4
14
  fade?: boolean;
5
15
  }
6
16
  declare const TabPane: React.FunctionComponent<ITabPaneProps>;
package/lib/index.d.ts CHANGED
@@ -1,11 +1,24 @@
1
+ /**
2
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
3
+ * SPDX-License-Identifier: BSD-3-Clause
4
+ */
1
5
  import React from 'react';
2
6
  import Content from './Content';
3
7
  import Item from './Item';
4
8
  import TabPane from './TabPane';
5
9
  export declare type DisplayType = null | 'basic' | 'underline';
6
10
  interface IProps extends React.HTMLAttributes<HTMLUListElement> {
11
+ /**
12
+ * Determines how tab is displayed.
13
+ */
7
14
  displayType?: DisplayType;
15
+ /**
16
+ * Justify the nav items according the tab content.
17
+ */
8
18
  justified?: boolean;
19
+ /**
20
+ * Applies a modern style to the tab.
21
+ */
9
22
  modern?: boolean;
10
23
  }
11
24
  declare const ClayTabs: React.FunctionComponent<IProps> & {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clayui/tabs",
3
- "version": "3.55.0",
3
+ "version": "3.56.0",
4
4
  "description": "ClayTabs component",
5
5
  "license": "BSD-3-Clause",
6
6
  "repository": "https://github.com/liferay/clay",
@@ -17,8 +17,8 @@
17
17
  ],
18
18
  "scripts": {
19
19
  "build": "cross-env NODE_ENV=production babel src --root-mode upward --out-dir lib --extensions .ts,.tsx",
20
- "build:types": "cross-env NODE_ENV=production tsc --project ./tsconfig.declarations.json",
21
- "prepublishOnly": "yarn build && yarn build:types",
20
+ "buildTypes": "cross-env NODE_ENV=production tsc --project ./tsconfig.declarations.json",
21
+ "prepublishOnly": "yarn build && yarn buildTypes",
22
22
  "test": "jest --config ../../jest.config.js"
23
23
  },
24
24
  "keywords": [
@@ -26,7 +26,7 @@
26
26
  "react"
27
27
  ],
28
28
  "dependencies": {
29
- "@clayui/shared": "^3.55.0",
29
+ "@clayui/shared": "^3.56.0",
30
30
  "classnames": "^2.2.6"
31
31
  },
32
32
  "peerDependencies": {
@@ -37,5 +37,5 @@
37
37
  "browserslist": [
38
38
  "extends browserslist-config-clay"
39
39
  ],
40
- "gitHead": "5310f4650d453a3659b0bc73a5f098732168c9c1"
40
+ "gitHead": "1c33d9c709d8ce071862f0087c76ac23ce11465b"
41
41
  }