IndexField_ger at

Inhaltsverzeichnis

• Beschreibung
• Code
• Parameter
  • onRender
• Code Sandbox

Beschreibung

Das IndexField ermöglicht es Ihnen die Daten Ihrer Unterseiten für Knöpfe usw. zu bauen. Es ist nicht möglich die Daten auf diesen Komponenten zu editieren. Für diesen Nutzungsfall benutzen Sie bitte unser StreamField

Code

import {fields} from '@snek-at/jaen-pages'

const Component = () => {
  return (
    <fields.IndexField
      fieldName="component-indexfield"
      fixedSlug={'pageId'}
      onRender={(page) => {
        return(
	  [...]
	)
      }}
    />
  )
}

export default Component

Parameter

Parameter	Art	Erforderlich	Beschreibung
fieldName	string	Ja	Der fieldName wird genutzt um dem Feld einen Namen zu geben. Der Name sollte beschreibend sein, um die Abfrage der Daten für Sie zu erleichtern.
fixedSlug	string	Nein	Mit dem fixedSlug können Sie entscheiden von welcher Seite Sie die Unterseiten verwenden wollen.
onRender	function	Ja	onRender erlaubt es Ihnen React Komponenten zu bauen.

onRender

Parameter	Art	Beschreibung
page	object	Mit page erhalten Sie die Seitendaten mit den Unterseiten in der Form eines Objekts.

Das Page Objekt schaut so aus:
──page
  ├── children
  ├── fields
  │   ├── your
  │   ├── fields
  │   └── here
  ├── images
  ├── pageMetaData
  │   ├── canonical
  │   ├── datePublished
  │   ├── description
  │   ├── image
  │   ├── isBlogPost
  │   └── title
  ├── parent
  ├── path
  ├── slug
  └── template

Code Sandbox

WIP