lit-access-control-conditions-modal

    1.1.34 • Public • Published

    This React package provides a modal for the use with Lit Protocol that lets the user choose the access control conditions under which to share content or data.

    Screenshot

    Example

    You can find an example implementation of this modal in the lit-access-control-conditions-modal-example repository.

    Installation

    yarn add lit-access-control-conditions-modal

    Note: This project requires a few peer dependencies so make sure you install them in your main project:

    • react
    • lit-js-sdk

    Usage

    import { ShareModal } from 'lit-access-control-conditions-modal'

    <ShareModal
              onClose={() => closeShareModal()}
              sharingItems={selectedFiles}
              onAccessControlConditionsSelected={onAccessControlConditionsSelected}
              getSharingLink={getSharingLink}
              showStep={shareModalStep}
            />
    

    Props

    • onClose: Pass a function. This will be called when the user clicks the "X" button on the modal
    • sharingItems: An array of items being shared. Each item should have a "name" property.
    • onAccessControlConditionsSelected: Pass a function. This will be called when the user has selected their access control requirements.
    • getSharingLink: Pass a fuction. This will be used when the user clicks the "Copy share link" button. This function should return a string that is the url to be shared. This function will be called with the sharingItems[0] as a parameter. It is only used when sharingItems.length == 1
    • showStep: Optional. Pass a string. If you'd like to force the modal into a specific step, you can use this function. It will immediately show this step when opened. The options you can choose from are the keys in src/ShareModal.jsx in the ModalComponents variable. I use this because when a user picks their access control conditions, and onAccessControlConditionsSelected is called, I close this modal, and open a "file upload progress" modal. When the upload is complete, I show this modal again, but I set showStep to "accessCreated" so the user sees the page that lets them copy the share link.

    Keywords

    none

    Install

    npm i lit-access-control-conditions-modal

    DownloadsWeekly Downloads

    0

    Version

    1.1.34

    License

    MIT

    Unpacked Size

    470 kB

    Total Files

    152

    Last publish

    Collaborators

    • glitch003