directus/packages/gatsby-source-directus

gatsby-source-directus

Source plugin for pulling data into Gatsby from a Directus API.

Install

npm install --save @directus/gatsby-source-directus

Configure

Public data

For pulling public data, you don't need to authenticate.

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			url: `https://my-project.directus.app`,
		},
	},
];

Authentication

If you need data that is protected by permission rules, you need to authenticate.

With tokens

You can authenticate via user token.

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			url: `https://my-project.directus.app`,
			auth: {
				token: 'my-user-token',
			},
		},
	},
];

With email and password

You can authenticate via email and password.

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			url: `https://my-project.directus.app`,
			auth: {
				email: 'admin@example.com',
				password: 'password',
			},
		},
	},
];

Multiple projects

You can se which type/field Directus should pull it's data into. This allows for usage with multiple projects and better data organization.

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			url: `https://my-portal.directus.app`,
			type: {
				name: 'Portal',
				field: 'portal',
			},
		},
	},
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			url: `https://my-blog.directus.app`,
			type: {
				name: 'Blog',
				field: 'blog',
			},
		},
	},
];

Development mode

When in development, you can set dev.refresh to the amount of seconds it needs to refresh the Directus schema.

The accepted options are:

• a number (in seconds)
• a ms string like "5s", "1m", etc.

Defaults to "15s"

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			//...
			dev: {
				refresh: '5s',
			},
		},
	},
];

Advanced GraphQL options

You can pass more specific options to the gatsby-source-graphql plugin using graphql option.

// In your gatsby-config.js
plugins: [
	{
		resolve: '@directus/gatsby-source-directus',
		options: {
			//...
			graphql: {
				// options here are going to be forwarded to `gatsby-source-graphql`
				// note that some are calculated values, so the follow are not going to
				// be forwarded:
				//   `url`, `typeName`, `fieldName` and `refreshInterval`
			},
		},
	},
];

How to query

The default way to query data is to fetch items from directus field.

query {
	directus {
		items {
			my_collection {
				some_field
				other_field
			}
		}
	}
}

If you specify the field name, you must query from that field instead.

query {
	blog {
		items {
			posts {
				id
				title
				slug
				status
			}
		}
	}
	portal {
		items {
			pages {
				id
				title
				slug
				status
			}
		}
	}
}

Docs

See the docs