Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Document how a config field reads the blueprint's other fields

Ouverte
  • Quelque chose ne va pas ?
#2,003 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
40/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
javascript
Domaine
documentation

Piste de recherche

Start in the fieldtype documentation page of the statamic/docs repo, where injectPublishContext() is already covered, and look for a place to describe sibling-field access. Read the blueprint builder source for suggestableConditionFieldsProvider and its set-scoped variant, and check how the field-settings component receives suggestableConditionFields. Done means the page either documents a supported way for a config field to read sibling fields, including inside Replicator and Bard sets, or the issue gets a maintainer answer naming the supported API.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

The fieldtype docs cover how a fieldtype's own component reads other values in the form (injectPublishContext()), but not how a config field reads the other fields of the blueprint being edited. A config field is a component rendered inside the field-settings panel of the blueprint builder.

Use case

A custom date fieldtype offers "earliest date" and "latest date" config options. Each should be a select that lists the blueprint's other date fields, so a boundary can reference a sibling field by handle. To populate that select, the config field's Vue component needs the list of fields in the blueprint.

What works today (v6.26.0)

The only mechanism found is the blueprint builder's provided suggestableConditionFieldsProvider, the same provider the field-conditions builder uses:

inject: {
    suggestableConditionFieldsProvider: { default: null },
},

computed: {
    siblingFields() {
        return this.suggestableConditionFieldsProvider?.suggestableFields?.() ?? [];
    },
},

suggestableFields() returns the flat field list ({ handle, type, config: { display, ... } }).

Two things make it hard to rely on:

  • It isn't documented, so it's unclear whether it's meant for addons or may change between releases.
  • It behaves differently inside a Replicator or Bard set. There, the nearest provider is the set-scoped variant, whose suggestableFields(vm) reads vm.section.fields and throws when called without an argument. A config field has no section to pass, so the set's sibling fields have to be found by walking $parent to the field-settings component, which receives them as a suggestableConditionFields array.

injectPublishContext() doesn't cover this: inside the field-settings panel it resolves to the field's own config values, not the parent blueprint's fields.

Request

Either:

  • document suggestableConditionFieldsProvider (or whatever is intended for this) on the fieldtype page, including how it behaves inside sets; or
  • say which supported API a config field should use to read sibling fields, if the provider is internal.
Langage dominant
PHP
Étoiles
133
Forks
405
Merge moyen
21 h 45 min
PR mergées (30 j)
12

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de statamic/docs

Toutes les issues de statamic/docs

Issues similaires

Plus d'issues PHP

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.