https://github.com/arcblock/did-motif
https://github.com/arcblock/did-motif
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/arcblock/did-motif
- Owner: ArcBlock
- License: other
- Created: 2022-02-22T05:48:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-04T10:22:38.000Z (12 months ago)
- Last Synced: 2025-07-04T10:41:03.354Z (12 months ago)
- Language: JavaScript
- Size: 146 KB
- Stars: 2
- Watchers: 16
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DID Motif
A javascript library for generating [DID](https://github.com/ArcBlock/ABT-DID-Protocol) identicons.
## Installation
```bash
npm i @arcblock/did-motif
# Or Yarn
yarn add @arcblock/did-motif
```
## Usage
render DID Motif:
``` js
import { update } from '@arcblock/did-motif';
const element = document.getElementById('my-canvas');
// or const element = document.getElementById('my-svg');
update(element, 'z35n6X6rDp8rWWCGSiXZgvd42bixdLULmX8oX', { size: 36 });
```
render DID Motif with animation:
``` js
import { update } from '@arcblock/did-motif';
const element = document.getElementById('my-canvas');
// or const element = document.getElementById('my-svg');
update(element, 'z35n6X6rDp8rWWCGSiXZgvd42bixdLULmX8oX', { size: 36, animation: true });
```
use `toDataURL` to convert a DID to an image data URL, we can assign the `DataURL` as the value of the `src` attribute of `![]()
` element.
``` js
import { toDataURL } from '@arcblock/did-motif';
const img = document.getElementById('my-img');
img.src = toDataURL({ did: 'z35n6X6rDp8rWWCGSiXZgvd42bixdLULmX8oX', size: 36 });
```
See more examples and options of working with `@arcblock/did-motif` [here](https://github.com/ArcBlock/did-motif/blob/master/examples/index.js).
## License
Copyright 2018-2022 ArcBlock
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.