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.

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

Update docs for Flask 12.4 #1540

Merged
merged 19 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ of the [MetaMask developer page](https://metamask.io/developer/).

## September 2024

- Documented new [Snaps custom UI JSX components](/snaps/features/custom-ui) for Flask
version 12.4, and removed documentation for deprecated function-based library.
([#1540](https://github.com/MetaMask/metamask-docs/pull/1540))
- Documented [Snaps user-defined components](/snaps/features/custom-ui/user-defined-components).
([#1557](https://github.com/MetaMask/metamask-docs/pull/1557))
- Updated [Android SDK documentation](/wallet/how-to/use-sdk/mobile/android) with convenience
Expand Down
Binary file added snaps/assets/custom-ui-checkbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snaps/assets/custom-ui-file-input.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified snaps/assets/custom-ui-heading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snaps/assets/custom-ui-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snaps/assets/custom-ui-radio-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snaps/assets/custom-ui-selector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snaps/assets/custom-ui-tooltip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified snaps/assets/home-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 0 additions & 85 deletions snaps/features/custom-ui/dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ description: Display custom alert, confirmation, or prompt screens in MetaMask.
sidebar_position: 2
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Dialogs

You can display a dialog in the MetaMask UI using the
Expand Down Expand Up @@ -38,9 +35,6 @@ To display an alert that can only be acknowledged, call
[`snap_dialog`](../../reference/snaps-api.md#snap_dialog) with `type: "alert"`.
The following example displays custom UI that alerts the user when something happens in the system:

<Tabs>
<TabItem value="JSX">

```tsx title="index.tsx"
import { Box, Text, Heading } from "@metamask/snaps-sdk/jsx";

Expand All @@ -60,30 +54,6 @@ await snap.request({
// Code that should execute after the alert has been acknowledged.
```

</TabItem>
<TabItem value="Functions" deprecated>

```javascript title="index.js"
import { panel, text, heading } from "@metamask/snaps-sdk"

await snap.request({
method: "snap_dialog",
params: {
type: "alert",
content: panel([
heading("Something happened in the system"),
text("The thing that happened is..."),
]),
},
})

// Code that should execute after the alert has been acknowledged.
```

</TabItem>
</Tabs>


<p align="center">
<img src={require("../../assets/alert-dialog.png").default} alt="Alert dialog example" width="360px" style={{border: "1px solid #DCDCDC"}} />
</p>
Expand All @@ -95,9 +65,6 @@ To display a confirmation that can be accepted or rejected, call
The following example displays custom UI that asks the user to confirm whether they would like to
take an action:

<Tabs>
<TabItem value="JSX">

```tsx title="index.tsx"
import { Box, Text, Heading } from "@metamask/snaps-sdk/jsx";

Expand All @@ -119,31 +86,6 @@ if (result === true) {
}
```

</TabItem>
<TabItem value="Functions" deprecated>

```javascript title="index.js"
import { panel, text, heading } from "@metamask/snaps-sdk"

const result = await snap.request({
method: "snap_dialog",
params: {
type: "confirmation",
content: panel([
heading("Would you like to take the action?"),
text("The action is..."),
]),
},
})

if (result === true) {
// Do the action.
}
```

</TabItem>
</Tabs>

<p align="center">
<img src={require("../../assets/confirmation-dialog.png").default} alt="Confirmation dialog example" width="360px" style={{border: "1px solid #DCDCDC"}} />
</p>
Expand All @@ -156,9 +98,6 @@ Prompt dialogs also accept a `placeholder` value that displays in the input fiel

The following example displays custom UI that prompts the user to enter a wallet address:

<Tabs>
<TabItem value="JSX">

```tsx title="index.tsx"
import { Box, Text, Heading } from "@metamask/snaps-sdk/jsx";

Expand All @@ -179,30 +118,6 @@ const walletAddress = await snap.request({
// walletAddress will be a string containing the address entered by the user.
```

</TabItem>
<TabItem value="Functions" deprecated>

```javascript title="index.js"
import { panel, text, heading } from "@metamask/snaps-sdk"

const walletAddress = await snap.request({
method: "snap_dialog",
params: {
type: "prompt",
content: panel([
heading("What is the wallet address?"),
text("Please enter the wallet address to be monitored"),
]),
placeholder: "0x123...",
},
})

// walletAddress will be a string containing the address entered by the user.
```

</TabItem>
</Tabs>

<p align="center">
<img src={require("../../assets/prompt-dialog.png").default} alt="Prompt dialog example" width="360px" style={{border: "1px solid #DCDCDC"}} />
</p>
Expand Down
26 changes: 0 additions & 26 deletions snaps/features/custom-ui/home-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ description: Display a dedicated UI page in MetaMask for your Snap.
sidebar_position: 3
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Home pages

You can display a dedicated UI, or "home page," for your Snap within MetaMask.
Expand Down Expand Up @@ -35,9 +32,6 @@ MetaMask calls this method when a user selects your Snap name in the Snaps menu.

The following example displays custom UI that welcomes the user to the Snap's home page:

<Tabs>
<TabItem value="JSX">

```tsx title="index.tsx"
import type { OnHomePageHandler } from "@metamask/snaps-sdk";
import { Box, Heading, Text } from "@metamask/snaps-sdk/jsx";
Expand All @@ -54,26 +48,6 @@ export const onHomePage: OnHomePageHandler = async () => {
};
```

</TabItem>
<TabItem value="Functions" deprecated>

```typescript title="index.ts"
import type { OnHomePageHandler } from "@metamask/snaps-sdk"
import { panel, text, heading } from "@metamask/snaps-sdk"

export const onHomePage: OnHomePageHandler = async () => {
return {
content: panel([
heading("Hello world!"),
text("Welcome to my Snap home page!"),
]),
}
}
```

</TabItem>
</Tabs>

<p align="center">
<img src={require("../../assets/home-page.png").default} alt="Home page example" width="360px" style={{border: "1px solid #DCDCDC"}} />
</p>
Expand Down
Loading
Loading