Update Notify section on the docs site and within readme (#1612)

* Update notify docs on docs site and within readme * Update notify api docs * Add screenshots * Update signup link * Remove export from types in docs
blocknative · Mar 29, 2023 · 86726db · 86726db
1 parent 10b07be
commit 86726db
Show file tree

Hide file tree

Showing 12 changed files with 482 additions and 398 deletions.
diff --git a/assets/notify-custom-example.png b/assets/notify-custom-example.png
diff --git a/assets/notify-example.png b/assets/notify-example.png
diff --git a/assets/notify-preflight-example.png b/assets/notify-preflight-example.png
diff --git a/docs/src/lib/assets/notify-custom-example.png b/docs/src/lib/assets/notify-custom-example.png
diff --git a/docs/src/lib/assets/notify-example.png b/docs/src/lib/assets/notify-example.png
diff --git a/docs/src/lib/assets/notify-preflight-example.png b/docs/src/lib/assets/notify-preflight-example.png
diff --git a/docs/src/routes/docs/[...3]modules/core.md b/docs/src/routes/docs/[...3]modules/core.md
diff --git a/docs/yarn.lock b/docs/yarn.lock
diff --git a/packages/core/README.md b/packages/core/README.md
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/core",
-  "version": "2.16.0",
+  "version": "2.16.1-alpha.1",
   "description": "Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
   "keywords": [
     "Ethereum",

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -301,13 +301,36 @@ export type NotifyOptions = {
 export type Notification = {
   id: string
   key: string
-  type: NotificationType
   network: Network
   startTime?: number
-  eventCode: string
+  /**
+   * to completely customize the message shown
+   */
   message: string
+  /**
+   * handle codes in your own way - see codes here under the notify 
+   * prop default en file at ./packages/core/src/i18n/en.json
+   */
+  eventCode: string
+  /**
+   * icon type displayed (see `NotificationType` below for options)
+   */
+  type: NotificationType
+  /**
+   * time (in ms) after which the notification will be dismissed. If set 
+   * to `0` the notification will remain on screen until the user dismisses the 
+   * notification, refreshes the page or navigates away from the site 
+   * with the notifications
+   */
   autoDismiss: number
+  /**
+   * add link to the transaction hash. For instance, a link to the 
+   * transaction on etherscan
+   */
   link?: string
+  /**
+   * onClick handler for when user clicks the notification element
+   */
   onClick?: (event: Event) => void
 }
 

diff --git a/packages/demo/src/App.svelte b/packages/demo/src/App.svelte
@@ -318,7 +318,7 @@
     // },
     // Sign up for your free api key at www.Blocknative.com
     apiKey,
-    theme: 'system'
+    // theme: 'system'
   })
 
   // Subscribe to wallet updates