Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/numbersprotocol/capture-eye

Capture Eye
https://github.com/numbersprotocol/capture-eye

Last synced: about 2 months ago
JSON representation

Capture Eye

Awesome Lists containing this project

README 

        
# Capture Eye



[![](https://data.jsdelivr.com/v1/package/npm/@numbersprotocol/capture-eye/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@numbersprotocol/capture-eye)



[Capture Eye](https://captureapp.xyz/products/eye) widget seamlessly integrates into your website, facilitating secure and transparent provenance display and purchases of digital content directly from the creator.



- Easily integrate with your digital products

  - Capture Eye effortlessly blends with your existing platforms, elevating your content's value and trustworthiness.

- Decentralized storage of the actual media asset

  - Secure, immutable and long-lasting preservation of your original digital assets, enhancing their credibility and authenticity.






## Quickstart



```html



  



  

    

  



```



The Capture Eye comes with a helper component `media-viewer` that could automatically detect the source url file type and display image or video respectively. It is NOT necessary to use `` component. If you wish to use your own component to display the asset, you may use ``, `` or any other custom component as the child element of ``.



Visit the [interactive playground](https://playcode.io/capture_eye_demo) for the live demo.



## Component attributes



| Attribute Name | Required | Description |

| ---- | --- | --- |

| `nid` | Yes | The unique [Nid](https://docs.numbersprotocol.io/introduction/numbers-protocol/defining-web3-assets/numbers-id-nid) of the asset. 
 `` |

| `layout` | No | Decides which layout to display. Default value is `original`. Additional option includes `curated`. 
 `` |

| `visibility` | No | Visibility behavior. Default value is `hover`, showing Eye on mouse hover. Setting it to option `always` will make the Eye always shown. This attribute is `always` and cannot be customized on mobile devices. 
 `` |

| `cz-title` | No | Override the copyright zone title. 
 `` |

| eng-img | No | Sets the image for the engagement zone banner. Recommended dimensions: `320x120 px`. Supports multiple `eng-img` and `eng-link` pairs for rotating banners. If multiple pairs are provided by using comma to seperate each URL entry, the banner will rotate every 5 seconds. Ensure that the number of `eng-img` matches the number of `eng-link` entries. Use URL encoding to replace commas with `%2C` in the URLs. 
 `` |

| eng-link | No | Sets the URL for the engagement zone banner link. Each `eng-link` should correspond to an `eng-img` for proper pairing in rotating banners, following the same comma-separated rule.  
 `` |

| `action-button-text` | No | Override the default action button text (`View More`). 
 `` |

| `action-button-link` | No | Override the default action button link to Capture website. 
 `` |



## Integration with Frontend Frameworks



Capture Eye has been designed as a web component to facilitate seamless integration with both vanilla HTML and various frontend frameworks.



- [Vanilla HTML](#vanilla-html)



- [React](#react)



- [Angular](#angular)



- [Vue](#vue)



### Vanilla HTML



The most simple way of adding Capture Eye to a webpage is by importing via CDN and add the component tag:



```html



  



  

    

  



```



For a full example, see the [example html](dev/index.html).



To run a development server and view the example HTML in your browser, execute the following command:



```bash

npm run dev

```



### React



To add Capture Eye to a React application, first install the packages:



```bash

npm i @numbersprotocol/capture-eye @lit/react

```



Add the following code to define a React component for Capture Eye:



```ts

import React from 'react';

import { createComponent } from '@lit/react';

import { CaptureEye } from '@numbersprotocol/capture-eye';



const CaptureEyeComponent = createComponent({

  tagName: 'capture-eye',

  elementClass: CaptureEye,

  react: React,

  events: {

    onactivate: 'activate',

    onchange: 'change',

  },

});

```



Use the CaptureEyeComponent in JSX:



```jsx



  



```



### Angular



To add Capture Eye to an Angular application, first install the packages:



```bash

npm i @numbersprotocol/capture-eye @webcomponents/webcomponentsjs

```



Add the webcomponents loader to the `script` section in `angular.json`:



```json

...

"scripts": [

  "node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"

],

...

```



Make sure `CUSTOM_ELEMENTS_SCHEMA` is set in your module:



```ts

import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';

@NgModule({

  schemas: [CUSTOM_ELEMENTS_SCHEMA],

  ...

})

```



Finally, import the Capture Eye package in your `*.component.ts` and add the `` template tag to your component:



```ts

import '@numbersprotocol/capture-eye';

```



```html



  



```



### Vue



For Vue users, the usage is similar to use native HTML elements. The official Vue doc provides a guide on [Using Vue with Web Components](https://vuejs.org/guide/extras/web-components.html).



To add Capture Eye to a SFC, simply import the Capture Eye package in the script setup and add the component tag in the template:



```vue



import '@numbersprotocol/capture-eye';



  

    

      

    

  



```



## Controlling Capture Eye with JavaScript



The `` web component provides several methods to control its behavior programmatically. You can interact with the component using the following public methods:



### `get isOpened()`



**Description**: Returns a boolean indicating whether the modal is currently open.



**Usage**:



```javascript

const captureEyeElement = document.querySelector('capture-eye');

console.log(captureEyeElement.isOpened); // true if modal is open, false otherwise

```



### `open()`



**Description**: Opens the modal.



**Usage**:



```javascript

const captureEyeElement = document.querySelector('capture-eye');

captureEyeElement.open();

```



### `close()`



**Description**: Closes the modal.



**Usage**:



```javascript

const captureEyeElement = document.querySelector('capture-eye');

captureEyeElement.close();

```



## Style customization



Capture Eye utilizes shadow DOM for encapsulation as a web component. However, if needed, the encapsulated styles could still be modified for any specific customization need. The section uses vanilla HTML/JavaScript to demonstrate how it is done. For different frontend frameworks it could also be done easily following the same logic.



To customize the Capture Eye button, access and modify the shadow DOM of Capture Eye after it is loaded.



Example of changing the icon and width/height:



```html



  document.addEventListener('DOMContentLoaded', () => {

    const captureEyeElements = document.querySelectorAll('capture-eye');



    captureEyeElements.forEach((element) => {

      const img = element.shadowRoot.querySelector('.capture-eye-button img');

      img.src =

        'https://ipfs-pin.numbersprotocol.io/ipfs/bafybeief3yriouin54tzub5otnzka6muacrsu32tl2vxnaexgffizdxxqy';

      img.style.width = '30px';

      img.style.height = '30px';

    });

  });



```



In contrast to Capture Eye button, the Capture Eye modal is not a child element of it, instead it is injected to document root to act as a singleton and ensure it is not affected by parent element's inheritable styles, such as CSS transform.



Example of changing the modal background color:



```html



  document.addEventListener('DOMContentLoaded', () => {

    const captureEyeModal = document.querySelector('capture-eye-modal');

    const modalContentDiv =

      captureEyeModal.shadowRoot.querySelector('.modal-container');

    modalContentDiv.style.background = 'midnightblue';

  });



```