Add Visibility field config with new Hidden option

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',

resources/js/components/blueprints/RegularField.vue

@@ -10,7 +10,12 @@
  <svg-icon name="hyperlink" v-if="isReferenceField" class="text-grey-60 text-3xs ml-1 h-4 w-4" v-tooltip="__('Imported from fieldset') + ': ' + field.field_reference" />
  </div>
  <div class="flex-none pr-1 flex">
- <width-selector v-model="width" class="mr-1" />
+ <width-selector v-if="!isHidden" v-model="width" class="mr-1" />
+
+ <div v-else class="relative border border-grey-40 opacity-50 w-12 flex items-center justify-center mr-1">
+ <svg-icon name="hidden" class="h-4 w-4 opacity-50"></svg-icon>
+ </div>
+
  <button v-if="canDefineLocalizable"
  class="hover:text-grey-100 mr-1 flex items-center"
  :class="{ 'text-grey-100': localizable, 'text-grey-60': !localizable }"
@@ -101,6 +106,10 @@ export default {
  }
  },
 
+ isHidden() {
+ return this.fieldConfig.visibility === 'hidden';
+ },
+
  widthClass() {
  if (! this.isSectionExpanded) return 'blueprint-section-field-w-full';
 

resources/js/components/field-conditions/ValidatorMixin.js

@@ -11,25 +11,31 @@ export default {
  methods: {
  showField(field, dottedKey) {
  let dottedFieldPath = dottedKey || field.handle;
- let dottedPrefix = dottedKey? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+ let dottedPrefix = dottedKey ? dottedKey.replace(new RegExp('\.'+field.handle+'$'), '') : '';
+
+ // If we know the field is to permanently hidden, bypass validation.
+ if (field.visibility === 'hidden' || this.shouldForceHiddenField(dottedFieldPath)) {
+ this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
+ dottedKey: dottedFieldPath,
+ hidden: 'force',
+ omitValue: false,
+ });
 
- if (this.shouldForceHiddenField(dottedFieldPath)) {
  return false;
  }
 
+ // Use validation to determine whether field should be shown.
  let validator = new Validator(field, this.values, this.$store, this.storeName);
  let passes = validator.passesConditions();
 
- // TODO: The next tick here is necessary to fix #6018, but not sure it's the _right_ fix.
- // Something is loading differently, causing the below `hiddenByRevealerField` check
- // to fail, when the replicator is configured to collapse all sets by default 🤔
+ // Ensure DOM is updated to ensure all revealers are properly loaded and tracked before committing to store.
  this.$nextTick(() => {
- let hiddenByRevealerField = validator.hasRevealerCondition(dottedPrefix);
+ let hasRevealerCondition = validator.hasRevealerCondition(dottedPrefix);
 
  this.$store.commit(`publish/${this.storeName}/setHiddenField`, {
  dottedKey: dottedFieldPath,
  hidden: ! passes,
- omitValue: ! hiddenByRevealerField,
+ omitValue: (! passes) && (! hasRevealerCondition),
  });
  });
 

resources/js/components/fieldtypes/Fieldtype.vue

@@ -49,7 +49,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.config.read_only || false;
+ return this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  replicatorPreview() {

resources/js/components/fieldtypes/replicator/Field.vue

@@ -112,7 +112,7 @@ export default {
  },
 
  isReadOnly() {
- return this.readOnly || this.field.read_only || false;
+ return this.readOnly || this.field.visibility === 'read_only' || false;
  },
 
  classes() {

resources/js/components/publish/Field.vue

@@ -139,7 +139,7 @@ export default {
  isReadOnly() {
  if (this.storeState.isRoot === false && !this.config.localizable) return true;
 
- return this.isLocked || this.readOnly || this.config.read_only || false;
+ return this.isLocked || this.readOnly || this.config.visibility === 'read_only' || false;
  },
 
  isLocalizable() {

resources/lang/de/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/de_CH/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wird unter der Bezeichnung des Feldes angezeigt, genau wie dieser Text hier. Markdown wird unterstützt.',
  'fields_instructions_position_instructions' => 'Beschreibung über oder unter dem Feld anzeigen.',
  'fields_listable_instructions' => 'Steuert die Darstellung in der Listenansicht.',
- 'fields_read_only_instructions' => 'Die Bearbeitungsmöglichkeit im Control Panel deaktivieren.',
  'fieldset_import_fieldset_instructions' => 'Das zu importierende Fieldset.',
  'fieldset_import_prefix_instructions' => 'Ein Präfix, welches jedem Feld beim Import vorangestellt werden soll (z.B. hero_)',
  'fieldset_intro' => 'Fieldsets sind optionale Ergänzungen zu Blueprints und dienen als wiederverwendbare Partials, die in Blueprints verwendet werden können.',

resources/lang/en/messages.php

@@ -71,7 +71,7 @@
  'fields_instructions_instructions' => 'Shown under the field\'s display label, like this very text. Markdown is supported.',
  'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
  'fields_listable_instructions' => 'Control the listing column visibility.',
- 'fields_read_only_instructions' => 'Disable editing in the control panel.',
+ 'fields_visibility_instructions' => 'Control field visibility on publish forms.',
  'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',
  'fieldset_import_prefix_instructions' => 'The prefix that should be applied to each field when they are imported. eg. hero_',
  'fieldset_intro' => 'Fieldsets are an optional companion to blueprints, acting as reusable partials that can be used within blueprints.',

resources/lang/fr/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Texte affiché sous l’étiquette du champ (comme celui-ci). Markdown est pris en compte.',
  'fields_instructions_position_instructions' => 'Défini le positionnement des instructions par rapport au champ.',
  'fields_listable_instructions' => 'Contrôle la visibilité de ce champ dans les colonnes.',
- 'fields_read_only_instructions' => 'Désactivez la possibilité de modifier dans le panneau de contrôle.',
  'fieldset_import_fieldset_instructions' => 'Le jeu de champs à importer.',
  'fieldset_import_prefix_instructions' => 'Le préfixe à appliquer à chaque champ lors de leur importation. Ex. hero_',
  'fieldset_intro' => 'Les jeux de champs sont des compagnons optionnels des Blueprints qui vous permettent de créer des partiels réutilisables dans tous vos Blueprints.',

resources/lang/nb/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Vises under feltets visningsetikett, slik som denne teksten. Markdown støttes.',
  'fields_instructions_position_instructions' => 'Vis instruksjoner over eller under feltet.',
  'fields_listable_instructions' => 'Styrer om feltet skjules eller vises i lister.',
- 'fields_read_only_instructions' => 'Deaktiver redigering i kontrollpanelet.',
  'fieldset_import_fieldset_instructions' => 'Feltsettet som skal importeres.',
  'fieldset_import_prefix_instructions' => 'Prefikset som skal brukes på hvert felt når de importeres, for eksempel helt_',
  'fieldset_intro' => 'Feltsett er en valgfri ledsager til blueprint og fungerer som gjenbrukbare delreplikaer som kan brukes i blueprint.',

resources/lang/nl/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Wordt getoond onder het velds weergavelabel, net zoals deze tekst. Markdown is toegestaan.',
  'fields_instructions_position_instructions' => 'Waar de instructie gepositioneerd moet worden ten opzichte van het veld.',
  'fields_listable_instructions' => 'Bepaal of dit veld getoond moet worden als kolom in overzichtstabellen.',
- 'fields_read_only_instructions' => 'Schakel uit dat je het veld kunt wijzigen in het controle paneel.',
  'fieldset_import_fieldset_instructions' => 'De fieldset die geïmporteerd moet worden.',
  'fieldset_import_prefix_instructions' => 'Het voorvoegsel dat op ieder veld toegepast moet worden als ze worden geïmporteerd. Bijv: hero_',
  'fieldset_intro' => 'Fieldsets zijn een optionele toevoeging aan blueprints, het zijn herbruikbare partials die in blueprints gebruikt kunnen worden.',

resources/lang/ru/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => 'Показывается под отображаемой меткой поля, как этот самый текст. Поддерживается Markdown.',
  'fields_instructions_position_instructions' => 'Где должны располагаться инструкции относительно поля.',
  'fields_listable_instructions' => 'Управление видимостью столбца этого поля.',
- 'fields_read_only_instructions' => 'Отключить редактирование в панели управления.',
  'fieldset_import_fieldset_instructions' => 'Набор полей, который необходимо импортировать.',
  'fieldset_import_prefix_instructions' => 'Префикс, который должен быть применен к каждому полю при импорте. Например, `hero_`',
  'fieldset_intro' => 'Наборы полей являются дополнением к чертежам, действуя как многократно используемые частицы.',

resources/lang/zh_CN/messages.php

@@ -71,7 +71,6 @@
  'fields_instructions_instructions' => '显示在字段的显示标签下，就像文本一样。支持Markdown。',
  'fields_instructions_position_instructions' => '在字段上方或下方显示指示。',
  'fields_listable_instructions' => '控制此字段列的可见性。',
- 'fields_read_only_instructions' => '禁用控制面板中的编辑。',
  'fieldset_import_fieldset_instructions' => '要导入的字段集。',
  'fieldset_import_prefix_instructions' => '导入每个字段时应应用的前缀。例如。hero_',
  'fieldset_intro' => '字段集是蓝图的可选伴侣，允许您创建要在蓝图中使用的部分。',

resources/sass/components/blueprints.scss

@@ -89,8 +89,8 @@
 }
 
 .field-width-selector {
+ @apply w-12;
  display: flex;
- width: 49px;
  height: 20px;
  position: relative;
  cursor: pointer;

src/Fields/Blueprint.php

@@ -340,8 +340,8 @@ public function columns()
  ->fieldtype($field->fieldtype()->indexComponent())
  ->label(__($field->display()))
  ->listable($field->isListable())
- ->defaultVisibility($field->isVisible())
- ->visible($field->isVisible())
+ ->defaultVisibility($field->isVisibleOnListing())
+ ->visible($field->isVisibleOnListing())
  ->sortable($field->isSortable())
  ->defaultOrder($index + 1);
  })

src/Fields/Field.php

@@ -88,6 +88,19 @@ public function instructions()
  return array_get($this->config, 'instructions');
  }
 
+ public function visibility()
+ {
+ $visibility = Arr::get($this->config, 'visibility');
+
+ $legacyReadOnly = Arr::get($this->config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ return 'read_only';
+ }
+
+ return $visibility ?? 'visible';
+ }
+
  public function rules()
  {
  $rules = [$this->handle => $this->addNullableRule(array_merge(
@@ -172,7 +185,7 @@ public function isListable()
  return (bool) $this->get('listable');
  }
 
- public function isVisible()
+ public function isVisibleOnListing()
  {
  if (is_null($this->get('listable'))) {
  return in_array($this->handle, ['title', 'slug', 'date', 'author']);
@@ -181,6 +194,14 @@ public function isVisible()
  return ! in_array($this->get('listable'), [false, 'hidden'], true);
  }
 
+ /**
+ * @deprecated Use isVisibleOnListing() instead.
+ */
+ public function isVisible()
+ {
+ return $this->isVisibleOnListing();
+ }
+
  public function isSortable()
  {
  if (is_null($this->get('sortable'))) {
@@ -208,6 +229,8 @@ public function toPublishArray()
  'display' => $this->display(),
  'instructions' => $this->instructions(),
  'required' => $this->isRequired(),
+ 'visibility' => $this->visibility(),
+ 'read_only' => $this->visibility() === 'read_only', // Deprecated: Addon fieldtypes should now reference new `visibility` state.
  ]);
  }
 

src/Fields/FieldTransformer.php

@@ -92,6 +92,7 @@ private static function inlineFieldToVue($field): array
  $config['width'] = $config['width'] ?? 100;
  $config['localizable'] = $config['localizable'] ?? false;
  $config = static::normalizeRequiredValidation($config);
+ $config = static::normalizeVisibility($config);
 
  return [
  'handle' => $field['handle'],
@@ -158,4 +159,17 @@ protected static function normalizeRequiredValidation($config)
 
  return $config;
  }
+
+ protected static function normalizeVisibility($config)
+ {
+ $visibility = Arr::get($config, 'visibility');
+
+ $legacyReadOnly = Arr::pull($config, 'read_only');
+
+ if ($legacyReadOnly && ! $visibility) {
+ $config['visibility'] = 'read_only';
+ }
+
+ return $config;
+ }
 }

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -85,7 +85,7 @@ public function edit(Request $request, $collection, $entry)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  [$values, $meta] = $this->extractFromFields($entry, $blueprint);
@@ -248,7 +248,7 @@ public function create(Request $request, $collection, $site)
  }
 
  if (User::current()->cant('edit-other-authors-entries', [EntryContract::class, $collection, $blueprint])) {
- $blueprint->ensureFieldHasConfig('author', ['read_only' => true]);
+ $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only']);
  }
 
  $values = [];

src/Http/Controllers/CP/Fields/FieldsController.php

@@ -128,11 +128,16 @@ protected function blueprint($blueprint)
  'type' => 'section',
  ],
  ],
- 'read_only' => [
- 'display' => __('Read Only'),
- 'instructions' => __('statamic::messages.fields_read_only_instructions'),
- 'type' => 'toggle',
- 'validate' => 'boolean',
+ 'visibility' => [
+ 'display' => __('Visibility'),
+ 'instructions' => __('statamic::messages.fields_visibility_instructions'),
+ 'options' => [
+ 'visible' => __('Visible'),
+ 'read_only' => __('Read Only'),
+ 'hidden' => __('Hidden'),
+ ],
+ 'default' => 'visible',
+ 'type' => 'select',
  'width' => 33,
  ],
  ]);

src/Http/Controllers/CP/Users/UsersController.php

@@ -172,11 +172,11 @@ public function edit(Request $request, $user)
  $blueprint = $user->blueprint();
 
  if (! User::current()->can('edit roles')) {
- $blueprint->ensureField('roles', ['read_only' => true]);
+ $blueprint->ensureField('roles', ['visibility' => 'read_only']);
  }
 
  if (! User::current()->can('edit user groups')) {
- $blueprint->ensureField('groups', ['read_only' => true]);
+ $blueprint->ensureField('groups', ['visibility' => 'read_only']);
  }
 
  $fields = $blueprint

tests/Fields/BlueprintTest.php

@@ -359,6 +359,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'append' => null,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -380,6 +382,8 @@ public function converts_to_array_suitable_for_rendering_fields_in_publish_compo
  'component' => 'textarea',
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -454,6 +458,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  [
  'handle' => 'nested_deeper_two',
@@ -470,6 +476,8 @@ public function converts_to_array_suitable_for_rendering_prefixed_conditional_fi
  'required' => false,
  'antlers' => false,
  'default' => null,
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  ],
  ],
  ],
@@ -563,15 +571,15 @@ public function it_ensures_a_field_has_config()
  ],
  ]]);
 
- $fields = $blueprint->ensureFieldHasConfig('author', ['read_only' => true])->fields();
+ $fields = $blueprint->ensureFieldHasConfig('author', ['visibility' => 'read_only'])->fields();
 
  $this->assertEquals(['type' => 'text'], $fields->get('title')->config());
  $this->assertEquals(['type' => 'text'], $fields->get('content')->config());
 
  $expectedConfig = [
  'type' => 'text',
  'do_not_touch_other_config' => true,
- 'read_only' => true,
+ 'visibility' => 'read_only',
  ];
 
  $this->assertEquals($expectedConfig, $fields->get('author')->config());

tests/Fields/FieldTest.php

@@ -324,6 +324,8 @@ public function preProcess($data)
  'instructions' => 'Test instructions',
  'required' => true,
  'validate' => 'required',
+ 'visibility' => 'visible',
+ 'read_only' => false, // deprecated
  'component' => 'example',
  'a_config_field_with_pre_processing' => 'foo preprocessed',
  'a_config_field_without_pre_processing' => 'foo',