status-im/react-native
2
0
Fork 0
mirror of https://github.com/status-im/react-native.git synced 2025-01-11 01:56:26 +00:00
Code Issues Projects Releases Wiki Activity
react-native/docs/tabbarios.md
Héctor Ramos 64d80b13db Migrate to new documentation format 
Summary:
Now that the Component and API docs are no longer auto-generated, we need to consolidate on a new format for our jsdoc comments. Any help from the community will be appreciated.

In this initial pull request, we'll be tackling the following docs:

- `AccessibilityInfo`, an API doc.
- `ActivityIndicator`, a Component doc.
- `View`, a Component doc.

This top comment will serve as a style guide, and when in doubt, please refer to the individual commits in this PR.

Each commit should update a single component or API, along with any relevant markdown files.

- Documentation in the JavaScript source files should be succinct. Any verbosity should be moved over to the markdown docs in the website...
- ...by adding a link to the relevant method/prop on the website to every comment block.
- Avoid markdown style links in JavaScript source files, opt for plain old URIs.

Let code document itself:

- If a method is Flow typed, the comment block does not need to repeat this information.
- If a param can be one of several values, and the type definition is easily determined from the code, the values should not be repeated in the comment block. Again, move this to the markdown doc if not present already.
Closes https://github.com/facebook/react-native/pull/16790

Differential Revision: D6353840

Pulled By: hramos

fbshipit-source-id: 9712c459acc33092aae9909f3dd0b58a00b26afc
2017-11-16 17:04:45 -08:00

2.2 KiB
Raw Blame History

id title layout category permalink next previous
tabbarios TabBarIOS docs components docs/tabbarios.html tabbarios-item switch

Props

Reference

Props

barStyle

The style of the tab bar. Supported values are 'default', 'black'. Use 'black' instead of setting barTintColor to black. This produces a tab bar with the native iOS style with higher translucency.

Type Required
enum('default', 'black') No

barTintColor

Background color of the tab bar

Type Required
color No

itemPositioning

Specifies tab bar item positioning. Available values are:

  • fill - distributes items across the entire width of the tab bar
  • center - centers item in the available tab bar space
  • auto (default) - distributes items dynamically according to the user interface idiom. In a horizontally compact environment (e.g. iPhone 5) this value defaults to fill, in a horizontally regular one (e.g. iPad) it defaults to center.
Type Required
enum('fill', 'center', 'auto') No

style

Type Required
ViewPropTypes.style No

tintColor

Color of the currently selected tab icon

Type Required
color No

translucent

A Boolean value that indicates whether the tab bar is translucent

Type Required
bool No

unselectedItemTintColor

Color of unselected tab icons. Available since iOS 10.

Type Required
color No

unselectedTintColor

Color of text on unselected tabs

Type Required
color No