1.0.2 • Published 4 years ago

gatsby-source-publitio v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

Publitio logo

gatsby-source-publitio

Source plugin for getting files from your Publitio account

Usage

Install the plugin

npm install --save gatsby-source-publitio

or

yarn add gatsby-source-publitio

Add the plugin to your gatsby-config.js

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: 'gatsby-source-publitio',
      options: {
        // See options section for more information
      },
    },
  ],
}

Options

Required

KeyDescription
api_keyGet it from your Publitio Dashboard
api_secretGet it from your Publitio Dashboard

Optional

KeyDefault valueDescription
limit1000Maximum number of files to return. Maximum limit is 1000
offset0How many files should be skipped at the beginning of the result set
filter_privacyallSpecifies which files should be returned based on their privacy. Supported values are all, private and public
filter_extensionallSpecifies which files should be returned based on their extension. For a full list of extensions see supported extensions
filter_typeallSpecifies which files should be returned based on their type. Supported values are all, image, video and audio
filter_adallSpecifies which files should be returned based on their option_ad status. Supported values are all, enabled, disabled and new
tagsSearch query tags separated by + signs. You can append :any to list files which have any of the tags, or :all to list only files which have all of the tags. For example, use dogs+cats:any to select all files which either have the dogs or the cats tag
folderFolder ID or Path to list files from. Default lists all files. Use / to list top (root) folder files

Example of query

query ImagesQuery {
   allPublitioFile(filter: {type: { eq: "image" }}) {
    edges {
      node {
        title
        file {
          childImageSharp {
            fluid(maxWidth: 1920) {
              ...GatsbyImageSharpFluid
            }
          }
        }
      }
    }
  }
}