Skip to main content

Nav

Nav is an item within a navigational heirarchy of some kind, most often viewed as a menu.

type Nav {
  createdAt: Date!
  demandHqId: ID!
  href: String!
  label: String!
  navId: ID!
  navLevel: Int!
  navType: String!
  navs(
  after: String
  before: String
  first: Int
  last: Int
): NavConnection!
  parentNavId: ID
  position: Int
  storefrontId: ID!
  updatedAt: Date!
  updatedBy: ID!
}

Fields​

Nav.createdAt ● Date! non-null scalar​

Nav.demandHqId ● ID! non-null scalar​

Nav.href ● String! non-null scalar​

Where this Nav link should lead to. Can be an absolute or relative url. 768 character limit.

Nav.label ● String! non-null scalar​

The label for this Nav, limit 64 characters.

Nav.navId ● ID! non-null scalar​

Nav.navLevel ● Int! non-null scalar​

A number, representing where this Nav resides in the heirarchy. Immutable, and limited to 0 through 6. 0 is the top level, 1 is the second level, etc.

Nav.navType ● String! non-null scalar​

A string indicating the purpose of this Nav hierarchy, must match parentNav if applicable. Limit 128 characters.

Nav.navs ● NavConnection! non-null object​

List Child Navs for a nav.

Requires the user to have the nav/read permission on the associated DemandHq.

Nav.navs.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Nav.navs.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Nav.navs.first ● Int scalar​

Returns the first n elements from the list.

Nav.navs.last ● Int scalar​

Returns the last n elements from the list.

Nav.parentNavId ● ID scalar​

All Navs besides the root (Level 0) have a parentNavId. Immutable.

Nav.position ● Int scalar​

Where this Nav should be located with respect to other Navs. Need not be sequential or unique.

Nav.storefrontId ● ID! non-null scalar​

Nav.updatedAt ● Date! non-null scalar​

Nav.updatedBy ● ID! non-null scalar​

Returned by​

createNav mutation ● nav query ● updateNav mutation

Member of​

NavConnection object ● NavEdge object