# Guideline

> Type in domain **Guidelines**

- HTML: [Guideline.html](Guideline.html)
- Raw SDL: [Guideline.sdl](Guideline.sdl)
- Covered by: [llms.txt](../llms.txt)

Implements: `Node`

## Fields

- `id`: `ID!` — `Guideline` Id.
- `name`: `String` — `Guideline` name.
- `color`: `RgbaColor` — `Guideline` color.
- `url`: `Url!` — `Guideline` internal url.
- `designSettings`: `GuidelineDesignSettings!` _(beta)_ — `Guideline` design settings.
- `colorSchemes`: `[GuidelineColorScheme]!` _(beta)_ — `Guideline` color schemes.
- `libraryPages` (`limit`: `Int`, `page`: `Int`): `LibraryPageItems!` — Paginated list of `LibraryPage` items for `Guideline`.
- `navigation` (`language`: `String`, `limit`: `Int`, `page`: `Int`): `GuidelineNavigationItems!` _(beta)_ — Paginated navigation items for `Guideline`. The `language` argument must be set at the
highest applicable level within the query (e.g. on `brand.guidelines`); when omitted here,
the language already set upstream is reused.
- `pages` (`limit`: `Int`, `page`: `Int`): `GuidelinePageItems` _(beta)_ — A list of `GuidelinePage`s that belong to this `Guideline`
- `availableBlockTypes`: `[GuidelinePageBlockType!]!` _(beta)_ — The block types available for the `Guideline`.
- `contentSearch` (`input`: `GuidelineContentSearchInput!`): `GuidelineContentSearchItems` _(beta)_ — Searches the content of the `Guideline`.
- `defaultLanguage`: `Language` _(beta)_ — The default language of the `Guideline`, or `null` if not set.
- `translationLanguages`: `[Language]!` _(beta)_ — Languages in which the `Guideline` is available.

## Related mutations

- [`createGuidelineDocument`](../mutation/createGuidelineDocument.md)
- [`createGuidelineDocumentGroup`](../mutation/createGuidelineDocumentGroup.md)
- [`createGuidelineDocumentLibrary`](../mutation/createGuidelineDocumentLibrary.md)
- [`createGuidelineDocumentLink`](../mutation/createGuidelineDocumentLink.md)
- [`createGuidelineDocumentPage`](../mutation/createGuidelineDocumentPage.md)
- [`createGuidelineDocumentPageCategory`](../mutation/createGuidelineDocumentPageCategory.md)
- [`createGuidelineDocumentPageLink`](../mutation/createGuidelineDocumentPageLink.md)
- [`deleteGuidelineDocument`](../mutation/deleteGuidelineDocument.md)
- [`deleteGuidelineDocumentGroup`](../mutation/deleteGuidelineDocumentGroup.md)
- [`deleteGuidelineDocumentLibrary`](../mutation/deleteGuidelineDocumentLibrary.md)
- [`deleteGuidelineDocumentLink`](../mutation/deleteGuidelineDocumentLink.md)
- [`deleteGuidelineDocumentPage`](../mutation/deleteGuidelineDocumentPage.md)
- [`deleteGuidelineDocumentPageCategory`](../mutation/deleteGuidelineDocumentPageCategory.md)
- [`deleteGuidelineDocumentPageLink`](../mutation/deleteGuidelineDocumentPageLink.md)
- [`duplicateGuidelineDocumentPage`](../mutation/duplicateGuidelineDocumentPage.md)
- [`hideGuidelineDocumentFromNavigation`](../mutation/hideGuidelineDocumentFromNavigation.md)
- [`hideGuidelineDocumentGroupFromNavigation`](../mutation/hideGuidelineDocumentGroupFromNavigation.md)
- [`hideGuidelineDocumentLibraryFromNavigation`](../mutation/hideGuidelineDocumentLibraryFromNavigation.md)
- [`hideGuidelineDocumentPageFromNavigation`](../mutation/hideGuidelineDocumentPageFromNavigation.md)
- [`moveGuidelineDocumentPage`](../mutation/moveGuidelineDocumentPage.md)
- [`publishGuidelineDocumentPage`](../mutation/publishGuidelineDocumentPage.md)
- [`showGuidelineDocumentGroupInNavigation`](../mutation/showGuidelineDocumentGroupInNavigation.md)
- [`showGuidelineDocumentInNavigation`](../mutation/showGuidelineDocumentInNavigation.md)
- [`showGuidelineDocumentLibraryInNavigation`](../mutation/showGuidelineDocumentLibraryInNavigation.md)
- [`showGuidelineDocumentPageInNavigation`](../mutation/showGuidelineDocumentPageInNavigation.md)
- [`unpublishGuidelineDocumentPage`](../mutation/unpublishGuidelineDocumentPage.md)
- [`updateGuidelineDocument`](../mutation/updateGuidelineDocument.md)
- [`updateGuidelineDocumentGroup`](../mutation/updateGuidelineDocumentGroup.md)
- [`updateGuidelineDocumentLibrary`](../mutation/updateGuidelineDocumentLibrary.md)
- [`updateGuidelineDocumentLink`](../mutation/updateGuidelineDocumentLink.md)
- [`updateGuidelineDocumentPage`](../mutation/updateGuidelineDocumentPage.md)
- [`updateGuidelineDocumentPageCategory`](../mutation/updateGuidelineDocumentPageCategory.md)
- [`updateGuidelineDocumentPageLink`](../mutation/updateGuidelineDocumentPageLink.md)

## Reach via

Example queries that can return this type from the root `Query`.

### `brand › guidelines`

```graphql
query BrandGuidelines {
  brand(id: "…") {
    guidelines(limit: 25, page: 1) {
      items {
        __typename
        availableBlockTypes {
          name
          id
          settingsSchema
        }
        color {
          alpha
          blue
          green
          red
        }
        colorSchemes {
          name
          id
          isDefault
        }
        defaultLanguage {
          name
          code
        }
        designSettings {
          accentColors {
            key
            colors { color }
          }
          backgroundColors {
            color
            colorSchemeId
            isDefault
          }
          buttonStyles {
            borderWidth
            cornerRadius
            fontSize
            fontWeight
            defaultBackgroundColors { color }
            defaultBorderColors { color }
          }
          listStyles {
            bulletListStyles { level }
            numberedListStyles { level }
          }
          mainFontFamily {
            name
            provider
          }
        }
        id
        libraryPages {
          total
          page
          limit
          hasNextPage
          items {
            title
            id
            type
            assets {
              total
              page
              limit
              hasNextPage
              items { id }
            }
            collections {
              total
              page
              limit
              hasNextPage
              items { id }
            }
          }
        }
        name
        navigation {
          total
          page
          limit
          hasNextPage
          items {
            __typename
            ... on GuidelineCoverPageNavigationItem { id }
            ... on GuidelineDocumentGroupNavigationItem { id }
            ... on GuidelineDocumentLibraryNavigationItem { id }
            ... on GuidelineDocumentLinkNavigationItem { id }
            ... on GuidelineDocumentNavigationItem { id }
          }
        }
        pages {
          total
          page
          limit
          hasNextPage
          items {
            title
            id
            modifiedAt
            url
            sections {
              total
              page
              limit
              hasNextPage
              items { id }
            }
          }
        }
        translationLanguages {
          name
          code
        }
        url
      }
    }
  }
}
```

Raw: [`BrandGuidelines.sdl`](../examples/BrandGuidelines.sdl)

### `brands › guidelines`

```graphql
query BrandsGuidelines {
  brands {
    guidelines(limit: 25, page: 1) {
      items {
        __typename
        availableBlockTypes {
          name
          id
          settingsSchema
        }
        color {
          alpha
          blue
          green
          red
        }
        colorSchemes {
          name
          id
          isDefault
        }
        defaultLanguage {
          name
          code
        }
        designSettings {
          accentColors {
            key
            colors { color }
          }
          backgroundColors {
            color
            colorSchemeId
            isDefault
          }
          buttonStyles {
            borderWidth
            cornerRadius
            fontSize
            fontWeight
            defaultBackgroundColors { color }
            defaultBorderColors { color }
          }
          listStyles {
            bulletListStyles { level }
            numberedListStyles { level }
          }
          mainFontFamily {
            name
            provider
          }
        }
        id
        libraryPages {
          total
          page
          limit
          hasNextPage
          items {
            title
            id
            type
            assets {
              total
              page
              limit
              hasNextPage
              items { id }
            }
            collections {
              total
              page
              limit
              hasNextPage
              items { id }
            }
          }
        }
        name
        navigation {
          total
          page
          limit
          hasNextPage
          items {
            __typename
            ... on GuidelineCoverPageNavigationItem { id }
            ... on GuidelineDocumentGroupNavigationItem { id }
            ... on GuidelineDocumentLibraryNavigationItem { id }
            ... on GuidelineDocumentLinkNavigationItem { id }
            ... on GuidelineDocumentNavigationItem { id }
          }
        }
        pages {
          total
          page
          limit
          hasNextPage
          items {
            title
            id
            modifiedAt
            url
            sections {
              total
              page
              limit
              hasNextPage
              items { id }
            }
          }
        }
        translationLanguages {
          name
          code
        }
        url
      }
    }
  }
}
```

Raw: [`BrandsGuidelines.sdl`](../examples/BrandsGuidelines.sdl)