Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ __ts-tests__/
#
.eslintcache

# TypeScript
#
*.tsbuildinfo

# BUCK
#
buck-out/
Expand Down
33 changes: 33 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Build
build/
dist/
web-build/
docs/.cache-loader/
docs/build/
docs/dist/
docs/docs/components/
docs/public/react-native-paper/
example/coverage/
example/dist/

# generated docs
docs/5.x/_nav.json
docs/5.x/index.mdx
docs/5.x/docs/_meta.json
docs/5.x/docs/guides/_meta.json
docs/5.x/docs/components/_meta.json
docs/5.x/docs/components/**/_meta.json
docs/6.x/_nav.json
docs/6.x/index.mdx
docs/6.x/docs/_meta.json
docs/6.x/docs/guides/_meta.json
docs/6.x/docs/components/
docs/src/data/componentDocs6x.json

# generated by bob
lib/

# Expo
example/.expo/
example/android/
example/ios/
3 changes: 1 addition & 2 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

singleQuote: true
tabWidth: 2
trailingComma: "es5"
trailingComma: 'es5'
useTabs: false
5 changes: 4 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Production
/build
/test-results
/visual/output

# Generated files
.docusaurus
.cache-loader
/public/llms.txt
/public/react-native-paper

# Misc
.DS_Store
Expand Down
17 changes: 17 additions & 0 deletions docs/5.x/_nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"text": "Guides",
"link": "/docs/guides/getting-started",
"activeMatch": "^/docs/guides/"
},
{
"text": "Components",
"link": "/docs/components/ActivityIndicator",
"activeMatch": "^/docs/components/"
},
{
"text": "Showcase",
"link": "/docs/showcase",
"activeMatch": "^/docs/showcase$"
}
]
17 changes: 17 additions & 0 deletions docs/5.x/docs/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"type": "dir-section-header",
"name": "guides",
"label": "Guides"
},
{
"type": "dir-section-header",
"name": "components",
"label": "Components"
},
{
"type": "file",
"name": "showcase",
"label": "Showcase"
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,19 @@
title: ActivityIndicator
---

import PropTable from '@site/src/components/PropTable.tsx';
import ExtendsLink from '@site/src/components/ExtendsLink.tsx';
import ThemeColorsTable from '@site/src/components/ThemeColorsTable.tsx';
import ScreenshotTabs from '@site/src/components/ScreenshotTabs.tsx';
import ExtendedExample from '@site/src/components/ExtendedExample.tsx';
import PropTable from '@docs/components/PropTable.tsx';
import ExtendsLink from '@docs/components/ExtendsLink.tsx';
import ThemeColorsTable from '@docs/components/ThemeColorsTable.tsx';
import ScreenshotTabs from '@docs/components/ScreenshotTabs.tsx';
import ExtendedExample from '@docs/components/ExtendedExample.tsx';

Activity indicator is used to present progress of some activity in the app.
It can be used as a drop-in replacement for the ActivityIndicator shipped with React Native.




<ScreenshotTabs screenshotData={"screenshots/activity-indicator.gif"} baseUrl="/react-native-paper/"/>

<ScreenshotTabs screenshotData={'screenshots/activity-indicator.gif'} />

## Usage

```js
import * as React from 'react';
import { ActivityIndicator, MD2Colors } from 'react-native-paper';
Expand All @@ -29,68 +26,65 @@ const MyComponent = () => (
export default MyComponent;
```

## Props

## Props
<span />

<span />


<div>

### animating
### animating

</div>

<PropTable componentLink="ActivityIndicator" prop="animating" />

<div>

### color
### color

</div>

<PropTable componentLink="ActivityIndicator" prop="color" />

<div>

### size
### size

</div>

<PropTable componentLink="ActivityIndicator" prop="size" />

<div>

### hidesWhenStopped
### hidesWhenStopped

</div>

<PropTable componentLink="ActivityIndicator" prop="hidesWhenStopped" />

<div>

### style
### style

</div>

<PropTable componentLink="ActivityIndicator" prop="style" />

<div>

### theme
### theme

</div>

<PropTable componentLink="ActivityIndicator" prop="theme" />



<span />

## Theme colors

## Theme colors

<ThemeColorsTable themeColorsData={{"-":{"borderColor":"theme.colors.primary"}}} componentName="ActivityIndicator" />
<ThemeColorsTable
themeColorsData={{ '-': { borderColor: 'theme.colors.primary' } }}
componentName="ActivityIndicator"
/>

<span />
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Appbar
---

import PropTable from '@site/src/components/PropTable.tsx';
import ExtendsLink from '@site/src/components/ExtendsLink.tsx';
import ThemeColorsTable from '@site/src/components/ThemeColorsTable.tsx';
import ScreenshotTabs from '@site/src/components/ScreenshotTabs.tsx';
import ExtendedExample from '@site/src/components/ExtendedExample.tsx';
import PropTable from '@docs/components/PropTable.tsx';
import ExtendsLink from '@docs/components/ExtendsLink.tsx';
import ThemeColorsTable from '@docs/components/ThemeColorsTable.tsx';
import ScreenshotTabs from '@docs/components/ScreenshotTabs.tsx';
import ExtendedExample from '@docs/components/ExtendedExample.tsx';

A component to display action items in a bar. It can be placed at the top or bottom.
The top bar usually contains the screen title, controls such as navigation buttons, menu button etc.
Expand All @@ -15,14 +15,12 @@ The bottom bar usually provides access to a drawer and up to four actions.
By default Appbar uses primary color as a background, in dark theme with `adaptive` mode it will use surface colour instead.
See [Dark Theme](https://callstack.github.io/react-native-paper/docs/guides/theming#dark-theme) for more informations




<ScreenshotTabs screenshotData={"screenshots/appbar.png"} baseUrl="/react-native-paper/"/>

<ScreenshotTabs screenshotData={'screenshots/appbar.png'} />

## Usage

### Top bar

```js
import * as React from 'react';
import { Appbar } from 'react-native-paper';
Expand All @@ -40,6 +38,7 @@ export default MyComponent;
```

### Bottom bar

```js
import * as React from 'react';
import { StyleSheet } from 'react-native';
Expand Down Expand Up @@ -99,76 +98,76 @@ const styles = StyleSheet.create({
export default MyComponent;
```

## Props

## Props
<span />

<span />


<div>

### dark
### dark

</div>

<PropTable componentLink="Appbar/Appbar" prop="dark" />

<div>

### children (required)
### children (required)

</div>

<PropTable componentLink="Appbar/Appbar" prop="children" />

<div>

### mode <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>
### mode <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>

</div>

<PropTable componentLink="Appbar/Appbar" prop="mode" />

<div>

### elevated <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>
### elevated <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>

</div>

<PropTable componentLink="Appbar/Appbar" prop="elevated" />

<div>

### safeAreaInsets
### safeAreaInsets

</div>

<PropTable componentLink="Appbar/Appbar" prop="safeAreaInsets" />

<div>

### theme
### theme

</div>

<PropTable componentLink="Appbar/Appbar" prop="theme" />

<div>

### style
### style

</div>

<PropTable componentLink="Appbar/Appbar" prop="style" />



<span />

## Theme colors

## Theme colors

<ThemeColorsTable themeColorsData={{"default":{"backgroundColor":"theme.colors.surface"},"elevated":{"backgroundColor":"theme.colors.elevation.level2"}}} componentName="Appbar" />

<ThemeColorsTable
themeColorsData={{
default: { backgroundColor: 'theme.colors.surface' },
elevated: { backgroundColor: 'theme.colors.elevation.level2' },
}}
componentName="Appbar"
/>

<span />
Loading
Loading