Skip to content

Commit

Permalink
fix: typo checks
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremybarbet committed Apr 25, 2020
1 parent 7bd13db commit c94bbc6
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![npm version](https://badge.fury.io/js/react-native-modalize.svg)](https://badge.fury.io/js/react-native-modalize)

A modal that loves scrollable content.
A highly customizable modal that loves scrolling content.

This component has been built with `react-native-gesture-handler` to address the common issue of **scrolling**, **swipping** and handling the **keyboard** behaviors, you can face with react-native's modal.
This component has been built with `react-native-gesture-handler` to address the common issue of **scrolling**, **swiping** and handling the **keyboard** behaviors, you can face with react-native's modal.

This component comes with a ScrollView, the default renderer, a FlatList and a SectionList. They are all three built-in and make your life easier, just pass your content and Modalize will handle the rest for you.
This component comes with a ScrollView, the default renderer, a FlatList or a SectionList. They are all three built-in and make your life easier, just pass your content and Modalize will handle the rest for you. You can also have the possibility to pass your own custom renderer.

<p align="left">
<img src="https://user-images.githubusercontent.com/937328/59955680-22f6d200-947b-11e9-8744-991a728596df.gif" height="450" />
Expand Down
8 changes: 4 additions & 4 deletions docs/EXAMPLES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

All the examples are running under 3 differents navigators. Check out the [development section](/DEVELOPMENT.md) to find out how to run these examples.
All the examples are running under 3 different navigators. Check out the [development section](/DEVELOPMENT.md) to find out how to run these examples.

<div style="display: flex; justify-content: space-between; flex-direction: row;">
<div style="
Expand Down Expand Up @@ -39,17 +39,17 @@ All the examples are running under 3 differents navigators. Check out the [devel
">
<h5 style="margin-top: -5px; margin-bottom: 10px;">Expo</h5>
<p style="font-size: 16px">This example is running under Expo without any navigator.</p>
<p style="font-size: 16px; margin-bottom: 0;">An Expo app is avalaible at the <a href="https://exp.host/@jeremdsgn/react-native-modalize">following link</a>.</p>
<p style="font-size: 16px; margin-bottom: 0;">An Expo app is available at the <a href="https://exp.host/@jeremdsgn/react-native-modalize">following link</a>.</p>
</div>
</div>

?> All references to each file are going to the Expo folder but it's also available in the React Native Navigation and React Navigation folders and can be slighty different for the usage of each navigators.
?> All references to each file are going to the Expo folder but it's also available in the React Native Navigation and React Navigation folders and can be slightly different for the usage of each navigators.

---

#### Example with a FlatList

If you want to use anothe renderer than the default ScrollView, you can pass an object props for either the [FlatList](http://localhost:3000/#/PROPS?id=flatlistprops) or the [SectionList](http://localhost:3000/#/PROPS?id=sectionlistprops).
If you want to use another renderer than the default ScrollView, you can pass an object props for either the [FlatList](http://localhost:3000/#/PROPS?id=flatlistprops) or the [SectionList](http://localhost:3000/#/PROPS?id=sectionlistprops).

?> There is two complete examples called [Flat List](https://github.com/jeremybarbet/react-native-modalize/blob/master/examples/expo/src/components/modals/FlatList.js) and [Section List](https://github.com/jeremybarbet/react-native-modalize/blob/master/examples/expo/src/components/modals/SectionList.js) available in the examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Expo SDK v32 is using an old version of `react-native-gesture-handler` which has

**Can I make a vertical ScrollView inside the modal?**

First, this is an anti-pattern behavior. You shouldn't have two verticals scrollview wrapped together. But yes, it's possible. You will have to import the one from `react-native-gesture-handler`.
First, this is an anti-pattern behavior. You shouldn't have two verticals ScrollView wrapped together. But yes, it's possible. You will have to import the one from `react-native-gesture-handler`.

```tsx
import { ScrollView } from 'react-native-gesture-handler';
Expand Down
2 changes: 1 addition & 1 deletion docs/METHODS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The method to open Modalize.

The method to close Modalize. You don't need to call it to dismiss the modal, since you can swipe down to dismiss.

?> If you are using `alwaysOpen` prop, you can supply a `dest` argument to the `close` method to reset it to the intial position `close('alwaysOpen')`, and avoiding to close it completely.
?> If you are using `alwaysOpen` prop, you can supply a `dest` argument to the `close` method to reset it to the initial position `close('alwaysOpen')`, and avoiding to close it completely.

| Type | Required |
| -------------------------------------------- | -------- |
Expand Down
8 changes: 4 additions & 4 deletions docs/PROPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ A React node that will define the content of the modal. By passing a children pr

An object to pass any of the react-native ScrollView's props.

Refer to the [`react-native` ScrollView documentation](https://reactnative.dev/docs/scrollview#props) to find out all the avaibles props.
Refer to the [`react-native` ScrollView documentation](https://reactnative.dev/docs/scrollview#props) to find out all the available props.

| Type | Required |
| ------ | -------- |
Expand All @@ -50,7 +50,7 @@ Refer to the [`react-native` ScrollView documentation](https://reactnative.dev/d

An object to pass any of the react-native FlatList's props. Using this props will replace the default `ScrollView` with the `FlatList` component.

Refer to the [`react-native` FlatList documentation](https://reactnative.dev/docs/flatlist#props) to find out all the avaibles props.
Refer to the [`react-native` FlatList documentation](https://reactnative.dev/docs/flatlist#props) to find out all the available props.

| Type | Required |
| ------ | -------- |
Expand All @@ -60,7 +60,7 @@ Refer to the [`react-native` FlatList documentation](https://reactnative.dev/doc

An object to pass any of the react-native SectionList's props. Using this props will replace the default `ScrollView` with the `SectionList` component.

Refer to the [`react-native` SectionList documentation](https://reactnative.dev/docs/sectionlist#props) to find out all the avaibles props.
Refer to the [`react-native` SectionList documentation](https://reactnative.dev/docs/sectionlist#props) to find out all the available props.

| Type | Required |
| ------ | -------- |
Expand Down Expand Up @@ -307,7 +307,7 @@ Animated.Value of the modal opening position between 0 and 1.

Wether or not you want to use the native driver with the `panGestureAnimatedValue`.

!> It's not really recommanded to set it to `false`, but sometimes you don't have choice, so this option is here for that.
!> It's not really recommended to set it to `false`, but sometimes you don't have choice, so this option is here for that.

| Type | Required | Default |
| ---- | -------- | ------- |
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![npm version](https://badge.fury.io/js/react-native-modalize.svg)](https://badge.fury.io/js/react-native-modalize)

A modal that loves scrollable content.
A highly customizable modal that loves scrolling content.

This component has been built with `react-native-gesture-handler` to address the common issue of **scrolling**, **swipping** and handling the **keyboard** behaviors, you can face with react-native's modal.
This component has been built with `react-native-gesture-handler` to address the common issue of **scrolling**, **swiping** and handling the **keyboard** behaviors, you can face with react-native's modal.

This component comes with a ScrollView, the default renderer, a FlatList and a SectionList. They are all three built-in and make your life easier, just pass your content and Modalize will handle the rest for you.
This component comes with a ScrollView, the default renderer, a FlatList or a SectionList. They are all three built-in and make your life easier, just pass your content and Modalize will handle the rest for you. You can also have the possibility to pass your own custom renderer.

<p align="left">
<img src="https://user-images.githubusercontent.com/937328/59955680-22f6d200-947b-11e9-8744-991a728596df.gif" height="450" />
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Modalize - A modal that loves scrollable content.</title>
<title>Modalize - A highly customizable modal that loves scrolling content.</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="A modal that loves scrollable content.">
<meta name="description" content="A highly customizable modal that loves scrolling content.">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
<link rel="stylesheet" href="//unpkg.com/prismjs/themes/prism-okaidia.css">
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "react-native-modalize",
"version": "1.3.7-rc.24",
"description": "A modal that loves scrollable content.",
"description": "A highly customizable modal that loves scrolling content.",
"main": "lib/index.js",
"types": "./lib/index.d.ts",
"scripts": {
Expand Down

0 comments on commit c94bbc6

Please sign in to comment.