Skip to content

Commit 65a3c79

Browse files
committed
docs: updated readme file
1 parent d9fe3bb commit 65a3c79

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,27 @@ A **60FPS** animated tab bar with a variety of cool animation presets 😎
1313

1414
## Table of Contents
1515

16-
1. [Installation](#installation)
17-
2. [Usage](#usage)
16+
1. [Features](#features)
17+
2. [Installation](#installation)
18+
3. [Usage](#usage)
1819
1. [Animated Icons](./docs/animated-icons.md)
19-
3. [Props](#props)
20-
4. [Presets](#presets)
20+
4. [Props](#props)
21+
5. [Presets](#presets)
2122
1. [Bubble Preset](./docs/bubble-preset.md)
2223
2. [Flashy Preset](./docs/flashy-preset.md)
23-
5. [To Do](#to-do)
24-
6. [Credits](#built-with)
25-
7. [License](#license)
24+
6. [To Do](#to-do)
25+
7. [Credits](#built-with)
26+
8. [License](#license)
27+
28+
## Features
29+
30+
- `60FPS` smooth animation for all presets.
31+
- Fully integrated with `React Navigation` v4 & v5.
32+
- Standalone usage.
33+
- Right-to-left layout support.
34+
- Accessibility support.
35+
- Written in `TypeScript`.
36+
2637

2738
## Installation
2839

@@ -38,6 +49,11 @@ npm install @gorhom/animated-tabbar
3849

3950
Originally `Animated TabBar` worked only with `React Navigation`, but I notice that it could be use as a standalone component and be more useful for the community.
4051

52+
Now the library export two main components:
53+
54+
- `AnimatedTabBar` ( **default** ) : the `React Navigation` integrated tab bar.
55+
- `AnimatedTabBarView`: the standalone tab bar.
56+
4157
<details>
4258
<summary>Standalone Component</summary>
4359

@@ -247,12 +263,12 @@ export default () => (
247263
| name | description | required | type | default |
248264
| -------------------- | --------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------- | -------- |
249265
| `preset` | Animation preset, currently options are `['bubble', 'flashy']`. | NO | [`PresetEnum`](./src/presets.ts#L15) | 'bubble' |
250-
| `tabs` | Tabs configurations. A generic dictionary of selected preset tab config. | YES | [`TabsConfig<T>`](./src/types.ts#L4) | |
266+
| `tabs` | Tabs configurations. A generic dictionary of selected preset tab config. | YES | [`TabsConfig<T>`](./src/types.ts#L5) | |
251267
| `style` | View style to be applied to tab bar container, `default value will be based on selected preset`. | NO | StyleProp<ViewStyle> | |
252268
| `duration` | Animation duration, `default value will be based on selected preset`. | NO | number | |
253269
| `easing` | Animation easing function, `default value will be based on selected preset`. | NO | [`EasingFunction`](https://github.com/software-mansion/react-native-reanimated/blob/master/src/Easing.js) | |
254-
| `itemInnerSpace` | Tab item inner space to be added to the tab item, `default value will be based on selected preset`. | NO | number \| [`Space`](./src/types.ts#L21) | |
255-
| `itemOuterSpace` | Tab item outer space to be added to the tab item, `default value will be based on selected preset`. | NO | number \| [`Space`](./src/types.ts#L21) | |
270+
| `itemInnerSpace` | Tab item inner space to be added to the tab item, `default value will be based on selected preset`. | NO | number \| [`Space`](./src/types.ts#L29) | |
271+
| `itemOuterSpace` | Tab item outer space to be added to the tab item, `default value will be based on selected preset`. | NO | number \| [`Space`](./src/types.ts#L34) | |
256272
| `itemContainerWidth` | Tab item width stretch strategy, `default value will be based on selected preset`. | NO | 'auto' \| 'fill' | |
257273
| `iconSize` | Tab item icon size, `default value will be based on selected preset`. | NO | number | |
258274
| `isRTL` | Tab bar layout and animation direction. | NO | boolean | false |

0 commit comments

Comments
 (0)