Skip to content

Fix typos in readme #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix typos in readme #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8f5ed9
Fix typos
xtyrrell Apr 17, 2021
4f22313
Revert useStorage change
xtyrrell Apr 17, 2021
b3f800a
Revert deleting newline
xtyrrell Apr 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const [value, setValue] = useStorage('mykey');

While Capacitor allows you to write to one API across several platforms, not all features are supported on all platforms. It is encouraged to check if the feature you intend to use is available before using it to avoid any runtime errors.

Each of the hook plugin paths exports an `availableFeatures` object, which contains a list features for that plugin. If the feature is supported for the current platform the app is running on, that feature will be true.:
Each of the hook plugin paths exports an `availableFeatures` object, which contains a list features for that plugin. If the feature is supported for the current platform the app is running on, that feature will be true:

```jsx
const { useStorageItem, availableFeatures } = `@capacitor-community/react-hooks/storage`;
Expand Down Expand Up @@ -151,7 +151,7 @@ import { useClipboard, availableFeatures } from '@capacitor-community/react-hook
const { value, getValue, setValue } = useClipboard();

const paste = useCallback(async () => {
await setValue('http://ionicframework.com/);
await setValue('http://ionicframework.com/');
}, [setValue]);

const copy = useCallback(async () => {
Expand Down Expand Up @@ -184,7 +184,7 @@ import:
import { useFilesystem, base64FromPath, availableFeatures } from '@capacitor-community/react-hooks/filesystem';
```

`useFilesystem` returns back common methods to gain access to file system apis.
`useFilesystem` returns back common methods to gain access to file system APIs.

```jsx
const { readFile } = useFilesystem();
Expand Down Expand Up @@ -313,4 +313,3 @@ const updateName = useCallback((n) => {
```

`useStorageItem` will use the initial value already in storage, or the one provided if there is no existing value.