Skip to content

Allow Link in Row and Address in Link #2761

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

Merged
merged 1 commit into from
Sep 25, 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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "Kn7XJHg0P1YYLU+sZF9pon4NXLadxLmUETLuLAn1qkw=",
"shasum": "OKpRMRDPOSMb+v1pNizzzKpUXrZIBLMJqXCh9xR3rFQ=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/browserify/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "xvq90PFxbF6rSf1t2+LeGCP5oeby0u7bobCT2ySxpF0=",
"shasum": "9olSQCt4yqefE+yiWvkXwsB966J81losYyHKyLaVgKI=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
22 changes: 22 additions & 0 deletions packages/snaps-sdk/src/jsx/components/Link.test.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Address } from './Address';
import { Icon } from './Icon';
import { Link } from './Link';

Expand Down Expand Up @@ -49,6 +50,27 @@ describe('Link', () => {
});
});

it('renders a link with an Address', () => {
const result = (
<Link href="https://example.com">
<Address address="0x1234567890123456789012345678901234567890" />
</Link>
);

expect(result).toStrictEqual({
type: 'Link',
key: null,
props: {
href: 'https://example.com',
children: {
type: 'Address',
key: null,
props: { address: '0x1234567890123456789012345678901234567890' },
},
},
});
});

it('renders a link with a conditional value', () => {
const result = (
<Link href="https://example.com">
Expand Down
7 changes: 6 additions & 1 deletion packages/snaps-sdk/src/jsx/components/Link.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { SnapsChildren } from '../component';
import { createSnapComponent } from '../component';
import type { AddressElement } from './Address';
import type { StandardFormattingElement } from './formatting';
import { type IconElement } from './Icon';
import { type ImageElement } from './Image';
Expand All @@ -8,7 +9,11 @@ import { type ImageElement } from './Image';
* The children of the {@link Link} component.
*/
export type LinkChildren = SnapsChildren<
string | StandardFormattingElement | IconElement | ImageElement
| string
| StandardFormattingElement
| IconElement
| ImageElement
| AddressElement
>;

/**
Expand Down
33 changes: 33 additions & 0 deletions packages/snaps-sdk/src/jsx/components/Row.test.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Address } from './Address';
import { Image } from './Image';
import { Link } from './Link';
import { Row } from './Row';
import { Text } from './Text';

Expand Down Expand Up @@ -73,4 +74,36 @@ describe('Row', () => {
},
});
});

it('renders a row with a Link', () => {
const result = (
<Row label="Foo">
<Link href="https://example.com">
<Address address="0x1234567890123456789012345678901234567890" />
</Link>
</Row>
);

expect(result).toStrictEqual({
type: 'Row',
key: null,
props: {
label: 'Foo',
children: {
type: 'Link',
key: null,
props: {
href: 'https://example.com',
children: {
type: 'Address',
key: null,
props: {
address: '0x1234567890123456789012345678901234567890',
},
},
},
},
},
});
});
});
4 changes: 3 additions & 1 deletion packages/snaps-sdk/src/jsx/components/Row.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { createSnapComponent } from '../component';
import type { AddressElement } from './Address';
import type { ImageElement } from './Image';
import type { LinkElement } from './Link';
import type { TextElement } from './Text';
import type { ValueElement } from './Value';

Expand All @@ -11,7 +12,8 @@ export type RowChildren =
| AddressElement
| ImageElement
| TextElement
| ValueElement;
| ValueElement
| LinkElement;

/**
* The props of the {@link Row} component.
Expand Down
8 changes: 8 additions & 0 deletions packages/snaps-sdk/src/jsx/validation.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1078,6 +1078,9 @@ describe('LinkStruct', () => {
<Link href="metamask://client/">
<Icon name="arrow-left" size="md" />
</Link>,
<Link href="https://example.com">
<Address address="0x1234567890123456789012345678901234567890" />
</Link>,
])('validates a link element', (value) => {
expect(is(value, LinkStruct)).toBe(true);
});
Expand All @@ -1100,6 +1103,11 @@ describe('LinkStruct', () => {
<Row label="label">
<Image src="<svg />" alt="alt" />
</Row>,
<Row label="label">
<Link href="https://example.com">
<Address address="0x1234567890123456789012345678901234567890" />
</Link>
</Row>,
])('does not validate "%p"', (value) => {
expect(is(value, LinkStruct)).toBe(false);
});
Expand Down
16 changes: 14 additions & 2 deletions packages/snaps-sdk/src/jsx/validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,13 @@ export const HeadingStruct: Describe<HeadingElement> = element('Heading', {
*/
export const LinkStruct: Describe<LinkElement> = element('Link', {
href: string(),
children: children([FormattingStruct, string(), IconStruct, ImageStruct]),
children: children([
FormattingStruct,
string(),
IconStruct,
ImageStruct,
AddressStruct,
]),
});

/**
Expand Down Expand Up @@ -691,7 +697,13 @@ export const TooltipStruct: Describe<TooltipElement> = element('Tooltip', {
*/
export const RowStruct: Describe<RowElement> = element('Row', {
label: string(),
children: typedUnion([AddressStruct, ImageStruct, TextStruct, ValueStruct]),
children: typedUnion([
AddressStruct,
ImageStruct,
TextStruct,
ValueStruct,
LinkStruct,
]),
variant: optional(
nullUnion([literal('default'), literal('warning'), literal('critical')]),
),
Expand Down
Loading