Skip to content
Source plugin for the dropbox api
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.eslintrc.json
.gitignore
.npmignore
.prettierignore
.prettierrc
LICENSE
README.md
index.js
package.json

README.md

gatsby-source-dropbox npm version

Source plugin for getting data from Dropbox account.

Install

npm install --save gatsby-source-dropbox

How to use

Configure the plugin

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-source-dropbox`,
    options: {
      accessToken: `access-token`,
      extensions: ['.pdf', '.jpg', '.png', '.md'],
      path: '/path/to/folder',
      recursive: false,
    },
  },
]

Options

  • accessToken: the token to use for querying dropbox. In order to get an access token you will need to create an app https://www.dropbox.com/developers/apps and generate one.
  • extensions: list of extensions used to filter out results
  • path: the folder to use to retrieve data. Defaults to '' which is the root of the dropbox project.
  • recursive: use this to retrieve files from subdirectories as well

How to query

The plugin provides some basic information of the remote files such as:

  • name the filename,
  • path the file path,
  • lastModified the last modification date,

The plugin makes use of the create remote node API of gatsby to locally download all the files in order to use them with other transformer plugins such as gatsby-transformer-sharp for images or gatsby-transformer-remark for markdown files.

Example:

query {
  allDropboxNode {
    edges {
      node {
        id
        name
        lastModified
        path
        localFile {
          childMarkdownRemark {
            html
          }
        }
      }
    }
  }
}
You can’t perform that action at this time.