@xyo-network/react-chain-blockies 1.7.6 → 1.7.8

package/README.md

@@ -8,13 +8,341 @@
 [![npm-license-badge][]](LICENSE)
 [![socket-badge][]][socket-link]
 
-Version: 1.7.3
-
 XYO Layer One React SDK Blockies
 
 ## Documentation
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__react-chain-blockies)
+## Reference
+
+**@xyo-network/react-chain-blockies**
+
+***
+
+## Interfaces
+
+- [BlockiesAccountProps](#interfaces/BlockiesAccountProps)
+- [BlockiesAvatarProps](#interfaces/BlockiesAvatarProps)
+- [BlockiesAvatarAddressProps](#interfaces/BlockiesAvatarAddressProps)
+- [BlockiesOptions](#interfaces/BlockiesOptions)
+
+## Variables
+
+- [BlockiesAccount](#variables/BlockiesAccount)
+- [BlockiesAvatar](#variables/BlockiesAvatar)
+- [BlockiesAvatarAddress](#variables/BlockiesAvatarAddress)
+
+## Functions
+
+- [buildOpts](#functions/buildOpts)
+- [renderIcon](#functions/renderIcon)
+- [createIcon](#functions/createIcon)
+
+### functions
+
+  ### <a id="buildOpts"></a>buildOpts
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+function buildOpts(opts): BlockiesOptions;
+```
+
+## Parameters
+
+### opts
+
+`Partial`\<[`BlockiesOptions`](#../interfaces/BlockiesOptions)\>
+
+## Returns
+
+[`BlockiesOptions`](#../interfaces/BlockiesOptions)
+
+  ### <a id="createIcon"></a>createIcon
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+function createIcon(opts): HTMLCanvasElement;
+```
+
+## Parameters
+
+### opts
+
+`Partial`\<[`BlockiesOptions`](#../interfaces/BlockiesOptions)\>
+
+## Returns
+
+`HTMLCanvasElement`
+
+  ### <a id="renderIcon"></a>renderIcon
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+function renderIcon(opts, canvas): HTMLCanvasElement;
+```
+
+## Parameters
+
+### opts
+
+`Partial`\<[`BlockiesOptions`](#../interfaces/BlockiesOptions)\>
+
+### canvas
+
+`HTMLCanvasElement`
+
+## Returns
+
+`HTMLCanvasElement`
+
+### interfaces
+
+  ### <a id="BlockiesAccountProps"></a>BlockiesAccountProps
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+## Extends
+
+- `Partial`\<[`BlockiesOptions`](#BlockiesOptions)\>
+
+## Properties
+
+### bgcolor?
+
+```ts
+optional bgcolor: string;
+```
+
+### Inherited from
+
+```ts
+Partial.bgcolor
+```
+
+***
+
+### color?
+
+```ts
+optional color: string;
+```
+
+### Inherited from
+
+```ts
+Partial.color
+```
+
+***
+
+### scale?
+
+```ts
+optional scale: number;
+```
+
+### Inherited from
+
+```ts
+Partial.scale
+```
+
+***
+
+### seed?
+
+```ts
+optional seed: string;
+```
+
+### Inherited from
+
+```ts
+Partial.seed
+```
+
+***
+
+### size?
+
+```ts
+optional size: number;
+```
+
+### Inherited from
+
+```ts
+Partial.size
+```
+
+***
+
+### spotcolor?
+
+```ts
+optional spotcolor: string;
+```
+
+### Inherited from
+
+```ts
+Partial.spotcolor
+```
+
+  ### <a id="BlockiesAvatarAddressProps"></a>BlockiesAvatarAddressProps
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+## Extends
+
+- `AvatarProps`
+
+## Properties
+
+### address?
+
+```ts
+optional address: string;
+```
+
+The Address to display
+
+***
+
+### borderSizeFactor?
+
+```ts
+optional borderSizeFactor: number;
+```
+
+Size of the border is the size prop * borderSizeFactor and rounded up
+
+***
+
+### size?
+
+```ts
+optional size: number;
+```
+
+The size of the avatar in pixels, defaults to 24
+
+  ### <a id="BlockiesAvatarProps"></a>BlockiesAvatarProps
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+## Extends
+
+- `AvatarProps`
+
+## Properties
+
+### blockiesOptions?
+
+```ts
+optional blockiesOptions: Partial<BlockiesOptions>;
+```
+
+  ### <a id="BlockiesOptions"></a>BlockiesOptions
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+## Properties
+
+### bgcolor
+
+```ts
+bgcolor: string;
+```
+
+***
+
+### color
+
+```ts
+color: string;
+```
+
+***
+
+### scale
+
+```ts
+scale: number;
+```
+
+***
+
+### seed
+
+```ts
+seed: string;
+```
+
+***
+
+### size
+
+```ts
+size: number;
+```
+
+***
+
+### spotcolor
+
+```ts
+spotcolor: string;
+```
+
+### variables
+
+  ### <a id="BlockiesAccount"></a>BlockiesAccount
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+const BlockiesAccount: React.FC<BlockiesAccountProps>;
+```
+
+  ### <a id="BlockiesAvatar"></a>BlockiesAvatar
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+const BlockiesAvatar: React.FC<BlockiesAvatarProps>;
+```
+
+  ### <a id="BlockiesAvatarAddress"></a>BlockiesAvatarAddress
+
+[**@xyo-network/react-chain-blockies**](#../README)
+
+***
+
+```ts
+const BlockiesAvatarAddress: React.FC<BlockiesAvatarAddressProps>;
+```
+
 
 ## Maintainers
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/react-chain-blockies",
-  "version": "1.7.6",
+  "version": "1.7.8",
   "description": "XYO Layer One React SDK Blockies",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -44,7 +44,7 @@
     "@types/react": "^19.1.8",
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig-react": "^7.0.0",
-    "knip": "^5.61.3",
+    "knip": "^5.62.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "typescript": "^5.8.3"