@nextcloud/sharing/README.md

Front-end utilities for Nextcloud files sharing

<!--
  - SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
  - SPDX-License-Identifier: GPL-3.0-or-later
-->

# `@nextcloud/sharing`

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-sharing)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-sharing)
[![npm](https://img.shields.io/npm/v/@nextcloud/sharing.svg)](https://www.npmjs.com/package/@nextcloud/sharing)

Common front-end utils for files sharing on Nextcloud and Nextcloud apps.

## Installation

```
npm i -S @nextcloud/sharing
```

## Usage

There are three entry points provided:

- The main entry point `@nextcloud/sharing` provides general utils for file sharing
- The _public_ entry point `@nextcloud/sharing/public` provides utils for handling public file shares
- The _ui_ entry point `@nextcloud/sharing/ui` provides API bindings to interact with the files sharing interface in the files app.