https://github.com/nextcloud-libraries/nextcloud-directediting

Nextcloud direct-editing postmessage API
https://github.com/nextcloud-libraries/nextcloud-directediting

Last synced: 10 months ago
JSON representation

Nextcloud direct-editing postmessage API

• Host: GitHub
• URL: https://github.com/nextcloud-libraries/nextcloud-directediting
• Owner: nextcloud-libraries
• License: agpl-3.0
• Created: 2022-11-15T09:19:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-06-02T06:22:54.000Z (11 months ago)
• Last Synced: 2025-06-02T17:16:09.119Z (11 months ago)
• Language: TypeScript
• Homepage:
• Size: 243 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          


# @nextcloud/directediting

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-directediting)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-directediting)

This library provides standardised functions for direct-editing interaction between the Nextcloud app and the clients.

## Installation

// TODO

## Usage

```js

import { DirectEditEmit, DirectEditListen } from '@nextcloud/directediting'

const directEditListen = new DirectEditisten()

const directEditEmit = new DirectEditEmit()

const MyApp = {

    registerEvents() {

        directEditListen.onClose(this.close)

    },

    

    async startup() {

        this.registerEvents()

        directEditEmit.loading()

        await this.load()

        directEditEmit.loaded()

    },

    

    close() {

        /* save changes, unmount, destroy ... */

        directEditEmit.close()

    },

    

    async load() { /* load the app... */ },

}

```