Skip to content
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

docs: mirai webView #99

Closed
wants to merge 1 commit into from
Closed

docs: mirai webView #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions website/docs/widgets/webview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# WebView

Mirai webView allows you to embed a web view of any link in your Flutter app using JSON, similar to the Flutter WebView package using JSON.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @dakshvasudev, the Mirai WebView is a separate package. Could you please include instructions on how to add the package to a project and integrate it effectively? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, Actually I am really new to this repo and in an earlier PR, you shared that u'll be creating a step-to-step guide on how to install the mirai repo and get rid of errors and then start testing what i build.

Hence, As of now I'm not sure of where the mirai webView as a package is installed. Could share that, I'd be happy to update the same.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dakshvasudev I have written the readme for mirai_webview here. You can copy from that.

To know more about the WebView package in Flutter, refer to the [official documentation](https://pub.dev/packages/webview_flutter).

## Properties

| Property | Type | Description |
| -------- | -------- | ----------------------------------- |
| url | `string` | The URL to be loaded in the WebView |

## Example JSON

```json
{
"type": "webView",
"url": "https://github.com/buildMirai/mirai"
}
```