forked from vkruglikov/react-telegram-web-app
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(TwaLoader): better doc description
- Loading branch information
Showing
6 changed files
with
105 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
[@altiore/twa](../README.md) / TwaLoaderProps | ||
|
||
# Interface: TwaLoaderProps | ||
|
||
The props type of [`TwaLoader`](../README.md#twaloader). | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [isTWApp](TwaLoaderProps.md#istwapp) | ||
- [loading](TwaLoaderProps.md#loading) | ||
- [noTWApp](TwaLoaderProps.md#notwapp) | ||
- [oldTWApp](TwaLoaderProps.md#oldtwapp) | ||
- [versionAtLeast](TwaLoaderProps.md#versionatleast) | ||
|
||
## Properties | ||
|
||
### isTWApp | ||
|
||
• `Optional` **isTWApp**: `React.JSX.Element` | ||
|
||
#### Type declaration | ||
|
||
▸ React.JSX.Element | ||
|
||
React Element will be shown in case if Telegram Web Application was successfully loaded and ready to use | ||
|
||
### loading | ||
|
||
• `Optional` **loading**: `React.JSX.Element` | ||
|
||
#### Type declaration | ||
|
||
▸ React.JSX.Element | ||
|
||
React Element will be shown wile Telegram Web Application loading (preparing for usage) | ||
|
||
### noTWApp | ||
|
||
• `Optional` **noTWApp**: `React.JSX.Element` | ||
|
||
#### Type declaration | ||
|
||
▸ React.JSX.Element | ||
|
||
React Element will be shown in case if application was loaded outside Telegram | ||
|
||
### oldTWApp | ||
|
||
• `Optional` **oldTWApp**: `React.JSX.Element` | ||
|
||
#### Type declaration | ||
|
||
▸ React.JSX.Element | ||
|
||
React Element will be shown in case if Telegram Web Application non-supported version (less, then versionAtLeast provided) | ||
|
||
### versionAtLeast | ||
|
||
• `Optional` **versionAtLeast**: `string` | `number` | ||
|
||
#### Type declaration | ||
|
||
▸ `string` | `number` | ||
|
||
Minimum supported version by current application. Using for [isTWApp](TwaLoaderProps.md#istwapp)|[oldTWApp](TwaLoaderProps.md#oldtwapp) components |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters