The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.
npm install dropbox[![Logo][logo]][repo]
The offical Dropbox SDK for Javascript.
Documentation can be found on [GitHub Pages][documentation]
Create an app via the [Developer Console][devconsole]
Install via npm
``
$ npm install --save dropbox
Install from source:
`
$ git clone https://github.com/dropbox/dropbox-sdk-js.git
$ cd dropbox-sdk-js
$ npm install
If you are using the repository from the browser, you can use any CDNs that hosts the Dropbox package by including a script tag with the link to the package. However, we highly recommend you do not directly import the latest version and instead choose a specific version. When we update and release a breaking change, this could break production code which we hope to avoid. Note, we follow semver naming conventions which means that any major version update could contain a breaking change.
After installation, follow one of our [Examples][examples] or read the [Documentation][documentation].
You can also view our [OAuth guide][oauthguide].
We provide [Examples][examples] to help get you started with a lot of the basic functionality in the SDK. We provide most examples in both Javascript and Typescript with some having a Node equivalent.
- OAuth
- Auth - [JS ] - A simple auth example to get an access token and list the files in the root of your Dropbox account.
- Simple Backend [JS ] - A simple example of a node backend doing a multi-step auth flow for Short Lived Tokens.
- PKCE Backend [JS ] - A simple example of a node backend doing a multi-step auth flow using PKCE and Short Lived Tokens.
- PKCE Browser [JS ] - A simple example of a frontend doing a multi-step auth flow using PKCE and Short Lived Tokens.
- Other Examples
- Basic - [TS, JS ] - A simple example that takes in a token and fetches files from your Dropbox account.
- Download - [TS, JS ] - An example showing how to download a shared file.
- Team As User - [TS, JS ] - An example showing how to act as a user.
- Team - [TS, JS ] - An example showing how to use the team functionality and list team devices.
- Upload [TS, JS ] - An example showing how to upload a file to Dropbox.
If you find a bug, please see [CONTRIBUTING.md][contributing] for information on how to report it.
If you need help that is not specific to this SDK, please reach out to [Dropbox Support][support].
This SDK is distributed under the MIT license, please see [LICENSE][license] for more information.
[logo]: https://cfl.dropboxstatic.com/static/images/sdk/javascript_banner.png
[repo]: https://github.com/dropbox/dropbox-sdk-js
[documentation]: https://dropbox.github.io/dropbox-sdk-js/
[examples]: https://github.com/dropbox/dropbox-sdk-js/tree/main/examples
[license]: https://github.com/dropbox/dropbox-sdk-js/blob/main/LICENSE
[contributing]: https://github.com/dropbox/dropbox-sdk-js/blob/main/CONTRIBUTING.md
[devconsole]: https://dropbox.com/developers/apps
[oauthguide]: https://www.dropbox.com/lp/developers/reference/oauth-guide
[support]: https://www.dropbox.com/developers/contact