Skip to content

Commit 231b3c5

Browse files
update documentation and its package.json file
1 parent 0c5ec0d commit 231b3c5

File tree

2 files changed

+26
-17
lines changed

2 files changed

+26
-17
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
[![Test coverage](https://codecov.io/gh/dev-javascript/tabs-more-button/graph/badge.svg?token=GT1LU074L2)](https://codecov.io/gh/dev-javascript/tabs-more-button) [![NPM version](http://img.shields.io/npm/v/tabs-more-button.svg?style=flat-square)](http://npmjs.org/package/tabs-more-button) [![License](http://img.shields.io/npm/l/tabs-more-button.svg?style=flat-square)](LICENSE) [![npm download](https://img.shields.io/npm/dm/tabs-more-button.svg?style=flat-square)](https://npmjs.org/package/tabs-more-button) [![Build Status](https://travis-ci.org/ly-components/tabs-more-button.png)](https://travis-ci.org/ly-components/tabs-more-button)
44

5-
Responsive Tabs with more button
6-
7-
Making tabs responsive by hiding overflow tabs except active tab
5+
`tabs-more-button` is a lightweight library designed to enhance your tabbed interfaces by making them responsive.​ This package does not create or manage tabs, but it intelligently hides overflow tabs while ensuring that the active tab remains visible. Ideal for scenarios where space is limited
86

97
## Features
108

9+
- Responsive
10+
1111
- `Vertical` support
1212

1313
- `rtl` support
@@ -70,7 +70,7 @@ document.getElementById('view-more-button').addEventListener('click', () => cons
7070

7171
## Rules
7272

73-
- `view more` button should be sibling element of `Tablist` element
73+
- `view more` button is required to display the hidden tabs and should be next sibling element of `Tablist` element
7474

7575
- `tabs` and `view more` button should be kept on same line
7676

@@ -81,12 +81,12 @@ document.getElementById('view-more-button').addEventListener('click', () => cons
8181
- buttonElement
8282

8383
- type : `HtmlELement`
84-
- description : `view more` button (should be sibling element of `Tablist` element)
84+
- description : `view more` button
8585

8686
- containerElement
8787

8888
- type : `HtmlELement`
89-
- description : the first ancestor of `view more` button which its `width|height` is not relative to `Tablist` element but is relative to `viewport`
89+
- description : parent element of `view more` button and `Tablist` element
9090

9191
- tablistElement
9292

@@ -101,7 +101,7 @@ document.getElementById('view-more-button').addEventListener('click', () => cons
101101

102102
- containerDisplay?
103103

104-
- type : `string`
104+
- type : `"flex"`|`"block"`
105105
- description : `display` value for `containerElement`
106106
- default value : `flex`
107107

package.json

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,29 @@
22
"name": "tabs-more-button",
33
"version": "1.0.1",
44
"private": false,
5+
"description": "A lightweight library for making tabbed interfaces responsive by hiding overflow tabs while keeping the active tab visible.",
6+
"keywords": [
7+
"tabs",
8+
"responsive",
9+
"responsive tabs",
10+
"more button",
11+
"show more",
12+
"view more",
13+
"js",
14+
"javascript",
15+
"user-interface",
16+
"web",
17+
"overflow",
18+
"active tab",
19+
"tab management",
20+
"horizontal tabs",
21+
"vertical tabs",
22+
"RTL"
23+
],
524
"author": {
625
"name": "dev-javascript",
726
"email": "javascript.code.dev@gmail.com"
827
},
9-
"description": "Responsive Tabs with more button",
1028
"main": "lib/cjs/api.js",
1129
"module": "lib/esm/api.js",
1230
"repository": {
@@ -67,15 +85,6 @@
6785
"index.d.ts",
6886
"__tests__"
6987
],
70-
"keywords": [
71-
"tabs",
72-
"responsive",
73-
"more-button",
74-
"show-more",
75-
"view-more",
76-
"js",
77-
"javascript"
78-
],
7988
"license": "MIT",
8089
"directories": {
8190
"lib": "lib"

0 commit comments

Comments
 (0)