updated widget docs

niftykit-inc · Jan 31, 2024 · 1d15162 · 1d15162
1 parent 9894e36
commit 1d15162
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 40 deletions.
diff --git a/packages/widgets/src/components/nk-dialog/readme.md b/packages/widgets/src/components/nk-dialog/readme.md
@@ -23,7 +23,6 @@
  - [nk-drop-mint-winter-button](../nk-drop-mint-winter-button)
  - [nk-edition-mint-button](../nk-edition-mint-button)
  - [nk-edition-mint-crossmint-button](../nk-edition-mint-crossmint-button)
- - [nk-pro-mint-button](../nk-pro-mint-button)
 
 ### Graph
 ```mermaid
@@ -33,7 +32,6 @@ graph TD;
   nk-drop-mint-winter-button --> nk-dialog
   nk-edition-mint-button --> nk-dialog
   nk-edition-mint-crossmint-button --> nk-dialog
-  nk-pro-mint-button --> nk-dialog
   style nk-dialog fill:#f9f,stroke:#333,stroke-width:4px
 ```
 

diff --git a/packages/widgets/src/components/nk-drop-mint-button/readme.md b/packages/widgets/src/components/nk-drop-mint-button/readme.md
@@ -7,12 +7,14 @@
 
 ## Properties
 
-| Property          | Attribute           | Description                       | Type     | Default                        |
-| ----------------- | ------------------- | --------------------------------- | -------- | ------------------------------ |
-| `successLink`     | `success-link`      | Link on the success modal         | `string` | `''`                           |
-| `successLinkText` | `success-link-text` | Link text on the success modal    | `string` | `'here'`                       |
-| `successMessage`  | `success-message`   | Body message on the success modal | `string` | `'Successfully minted an NFT'` |
-| `successTitle`    | `success-title`     | Title on the success modal        | `string` | `'Success'`                    |
+| Property           | Attribute            | Description                                     | Type     | Default                        |
+| ------------------ | -------------------- | ----------------------------------------------- | -------- | ------------------------------ |
+| `successImageUrl`  | `success-image-url`  | Image url for the success modal                 | `string` | `''`                           |
+| `successLink`      | `success-link`       | Link on the success modal                       | `string` | `''`                           |
+| `successLinkText`  | `success-link-text`  | Link text on the success modal                  | `string` | `'here'`                       |
+| `successMessage`   | `success-message`    | Body message on the success modal               | `string` | `'Successfully minted an NFT'` |
+| `successTextAlign` | `success-text-align` | Align text on the success modal (default: left) | `string` | `''`                           |
+| `successTitle`     | `success-title`      | Title on the success modal                      | `string` | `'Success'`                    |
 
 
 ## Methods

diff --git a/packages/widgets/src/components/nk-pro-mint-button/readme.md b/packages/widgets/src/components/nk-pro-mint-button/readme.md
@@ -7,23 +7,12 @@
 
 ## Properties
 
-| Property         | Attribute         | Description                       | Type     | Default                        |
-| ---------------- | ----------------- | --------------------------------- | -------- | ------------------------------ |
-| `successMessage` | `success-message` | Body message on the success modal | `string` | `'Successfully minted an NFT'` |
-| `successTitle`   | `success-title`   | Title on the success modal        | `string` | `'Success'`                    |
-
-
-## Methods
-
-### `mint(quantity: number) => Promise<void>`
-
-
-
-#### Returns
-
-Type: `Promise<void>`
-
-
+| Property                    | Attribute       | Description   | Type      | Default     |
+| --------------------------- | --------------- | ------------- | --------- | ----------- |
+| `collectionId` _(required)_ | `collection-id` | Collection ID | `string`  | `undefined` |
+| `isDev`                     | `is-dev`        |               | `boolean` | `undefined` |
+| `publicKey` _(required)_    | `public-key`    | Public Key    | `string`  | `undefined` |
+| `unique`                    | `unique`        |               | `boolean` | `undefined` |
 
 
 ## Shadow Parts
@@ -32,22 +21,7 @@ Type: `Promise<void>`
 | ---------------------- | ----------- |
 | `"mint-btn"`           |             |
 | `"mint-btn-container"` |             |
-| `"mint-dropdown-icon"` |             |
-| `"mint-text"`          |             |
-
-
-## Dependencies
-
-### Depends on
-
-- [nk-dialog](../nk-dialog)
 
-### Graph
-```mermaid
-graph TD;
-  nk-pro-mint-button --> nk-dialog
-  style nk-pro-mint-button fill:#f9f,stroke:#333,stroke-width:4px
-```
 
 ----------------------------------------------