diff --git a/CHANGELOG.md b/CHANGELOG.md index 19abad6f36..1df79bf05d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,40 +4,39 @@ ### Patch Changes -- f9f7652: - **feat**: added option for mint action on a Frame. By @zizzamia #93 - - **feat**: added option for simple static links when creating a Frame. By @zizzamia #93 - - **feat**: added `wrapper` prop to `` component, that defaults to `React.Fragment` when not passed (original behavior). By @syntag #90 #91 - - **feat**: exported `FrameMetadataResponse` type which can be useful when using `getFrameMetadata` in a TS project. By @syntag #90 +- **feat**: added option for mint action on a Frame. By @zizzamia #93 f9f7652 +- **feat**: added option for simple static links when creating a Frame. By @zizzamia #93 +- **feat**: added `wrapper` prop to `` component, that defaults to `React.Fragment` when not passed (original behavior). By @syntag #90 #91 +- **feat**: exported `FrameMetadataResponse` type which can be useful when using `getFrameMetadata` in a TS project. By @syntag #90 ## 0.5.0 ### Minor Changes -- dc6f33d: - **fix**: ensured that the `` component uses the `name` property instead of the `property` property to set the type of metadata. Both options are technically correct, but historically, using `name` is more accurate. +- **fix**: ensured that the `` component uses the `name` property instead of the `property` property to set the type of metadata. Both options are technically correct, but historically, using `name` is more accurate. dc6f33d +- **feat**: renamed the component from `OnchainName` to `Name` in our Identity Kit. This is a breaking changes. The purpose of the rename is to simplify and enhance clarity. By @alvaroraminelli #86 - - **feat**: renamed the component from `OnchainName` to `Name` in our Identity Kit. This is a breaking changes. The purpose of the rename is to simplify and enhance clarity. By @alvaroraminelli #86 - - BREAKING CHANGES +BREAKING CHANGES - To enhance usability and intuitiveness, the component name has been simplified. `OnchainName` is now renamed to `Name`. +To enhance usability and intuitiveness, the component name has been simplified. `OnchainName` is now renamed to `Name`. - Before +Before - ```ts - import { OnchainName } from '@coinbase/onchainkit'; +```ts +import { OnchainName } from '@coinbase/onchainkit'; - ... - - ``` +... + +``` - After +After - ```ts - import { Name } from '@coinbase/onchainkit'; +```ts +import { Name } from '@coinbase/onchainkit'; - ... - - ``` +... + +``` ## 0.4.5 diff --git a/README.md b/README.md index a08e5b5f43..9a5d2ee42e 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,13 @@ export default function HomePage() { label: 'Tell me the story', }, { - label: 'Redirect to cute dog pictures', + action: 'link', + label: 'Link to Google', + target: 'https://www.google.com' + }, + { action: 'post_redirect', + label: 'Redirect to cute pictures', }, ]} image="https://zizzamia.xyz/park-1.png" @@ -111,10 +116,16 @@ export default function HomePage() { **@Props** ```ts -type Button = { - label: string; - action?: 'post' | 'post_redirect'; -}; +type Button = + | { + action: 'link' | 'mint'; + label: string; + target: string; + } + | { + action?: 'post' | 'post_redirect'; + label: string; + }; type InputMetadata = { text: string; @@ -132,6 +143,10 @@ type FrameMetadataType = { // A period in seconds at which the app should expect the image to update. refresh_period?: number; }; + +type FrameMetadataReact = FrameMetadataType & { + wrapper?: React.ComponentType; +}; ``` **@Returns** @@ -139,8 +154,11 @@ type FrameMetadataType = { ```html - - + + + + + @@ -185,10 +203,16 @@ export async function POST(req: NextRequest): Promise { **@Param** ```ts -type Button = { - label: string; - action?: 'post' | 'post_redirect'; -}; +type Button = + | { + action: 'link' | 'mint'; + label: string; + target: string; + } + | { + action?: 'post' | 'post_redirect'; + label: string; + }; type InputMetadata = { text: string; @@ -344,10 +368,16 @@ export default function Page() { **@Param** ```ts -type Button = { - label: string; - action?: 'post' | 'post_redirect'; -}; +type Button = + | { + action: 'link' | 'mint'; + label: string; + target: string; + } + | { + action?: 'post' | 'post_redirect'; + label: string; + }; type InputMetadata = { text: string;