Access Block Label (blockName) in Field Configuration

[2nikhiltom]

Problem

When editors create a block in Payload, they choose a "Layout name" which becomes the block's label in the admin UI. However, there's no way to access this blockName value within the block's field configurations to auto-populate related fields.

Real-World Example

We have a ContentGeneric block where editors must:

1. Choose a Layout name (e.g., "Getting Started")
2. Manually type the same text into an H2 heading field

This creates unnecessary duplication and potential inconsistency.

What We Need

A way to access the block's blockName in field configurations. For example:

{
  name: 'heading',
  type: 'text',
  defaultValue: ({ blockName }) => blockName || '',
}

Or in a custom Field component:

const AutoPopulateHeading = ({ path }) => {
  const { value, setValue } = useField({ path });
  const blockName = useBlockName(); // hypothetical hook
  
  useEffect(() => {
    if (!value && blockName) {
      setValue(blockName);
    }
  }, [blockName]);
  
  return <TextInput path={path} />;
};

What We've Tried

1. Using useFormFields in a custom component:

const blockName = useFormFields(([fields]) => fields?.blockName?.value);

❌ Result: Field becomes read-only, users can't type

2. Using defaultValue with data parameter:

defaultValue: ({ data }) => data?.blockName

❌ Result: TypeScript error - blockName not in context type

3. Field-level hooks:
❌ Result: No access to block-level data

Why This Matters

• Reduces manual data entry
• Prevents inconsistencies between block labels and content
• Improves editor experience
• Common pattern in CMS workflows

Environment

• Payload CMS: 3.x (beta)
• Context: Nested blocks (Layout field → ContentGeneric block)

Current Workaround

Editors manually copy the Layout name to the heading field