You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/guides/01-getting-started.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ title: Getting Started
6
6
7
7
## Installation
8
8
9
-
* Open a Terminal in your project's folder and run:
9
+
- Open a Terminal in your project's folder and run:
10
10
11
11
```bash npm2yarn
12
12
npm install react-native-paper
13
13
```
14
14
15
-
* From `v5` there is a need to install [react-native-safe-area-context](https://github.com/th3rdwave/react-native-safe-area-context) for handling safe area.
15
+
- From `v5` there is a need to install [react-native-safe-area-context](https://github.com/th3rdwave/react-native-safe-area-context) for handling safe area.
16
16
17
17
```bash npm2yarn
18
18
npm install react-native-safe-area-context
@@ -24,12 +24,12 @@ Additionaly for `iOS` platform there is a requirement to link the native parts o
24
24
npx pod-install
25
25
```
26
26
27
-
* If you're on a vanilla React Native project, you also need to install and link [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons).
27
+
- If you're on a vanilla React Native project, you also need to install and link [@react-native-vector-icons/common](https://github.com/oblador/react-native-vector-icons).
28
28
29
-
Specifically `MaterialCommunityIcons` icon pack needs to be included in the project, because some components use those internally (e.g. `AppBar.BackAction` on Android).
29
+
Specifically `MaterialDesignIcons` icon pack needs to be included in the project, because some components use those internally (e.g. `AppBar.BackAction` on Android).
The library has specified dedicated steps for each platform. Please follow their [installation guide](https://github.com/oblador/react-native-vector-icons#installation) in order to properly use icon fonts.
@@ -54,7 +54,7 @@ module.exports = {
54
54
If you created your project using Expo, it'll look something like this:
Copy file name to clipboardExpand all lines: docs/docs/guides/03-icons.mdx
+29-25Lines changed: 29 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,17 +18,16 @@ Many components such as `Button` accept an `icon` prop which is used to display
18
18
19
19
### 1. An icon name
20
20
21
-
You can pass the name of an icon from [`MaterialCommunityIcons`](https://materialdesignicons.com). This will use the [`react-native-vector-icons`](https://github.com/oblador/react-native-vector-icons) library to display the icon.
21
+
You can pass the name of an icon from [`MaterialDesignIcons`](https://pictogrammers.com/library/mdi/). This will use the [`@react-native-vector-icons/material-design-icons`](https://github.com/oblador/react-native-vector-icons/tree/master/packages/material-design-icons) library to display the icon.
22
22
23
23
Example:
24
24
25
25
```js
26
-
<Button icon="camera">
27
-
Press me
28
-
</Button>
26
+
<Button icon="camera">Press me</Button>
29
27
```
30
28
31
-
<details><summary>See the list of supported icons</summary>
29
+
<details>
30
+
<summary>See the list of supported icons</summary>
32
31
<IconsList />
33
32
</details>
34
33
@@ -39,17 +38,17 @@ You can pass an image source, such as an object of shape `{ uri: 'https://path.t
You can also use a render function. Along with `size` and `color`, you have access to `direction` which will either be `'rtl'` or `'ltr'`. You can then decide how to render your icon component accordingly.
@@ -131,8 +135,8 @@ Example of using a render function:
@@ -230,7 +231,7 @@ Use `asset/resource`, since `file-loader` was deprecated in webpack v5.
230
231
}
231
232
```
232
233
233
-
## Load the Material Community Icons
234
+
## Load the Material Design Icons
234
235
235
236
If you followed the getting started guide, you should have the following code in your root component:
236
237
@@ -240,16 +241,16 @@ If you followed the getting started guide, you should have the following code in
240
241
</PaperProvider>
241
242
```
242
243
243
-
Now we need tweak this section to load the Material Community Icons from the [`react-native-vector-icons`](https://github.com/oblador/react-native-vector-icons) library:
244
+
Now we need tweak this section to load the Material Design Icons from the [`react-native-vector-icons`](https://github.com/oblador/react-native-vector-icons) library:
0 commit comments