Paragraph Type NCIDS Link Button - NCIOCPL/cgov-digital-platform GitHub Wiki
NCIDS Link Buttons can be placed:
- in the Primary Link field in NCIDS Hero components
- in Links field in NCIDS Call to Action Strip components
- in the Links field in NCIDS Guide Card with Image and Description components
(NOTE: More will be added here as MVP2 components get requirements).
Properties
There are three types of call to action:
- Link Button Internal - internal content and display fields
- Link Button External - custom URL and display fields
NCIDS Link Button Internal
- Display Name: NCIDS Link Button Internal
- Machine-readable Name: ncids_link_button_internal
- Description: Button linking to internal content.
- Translatable: No
Local Fields
Internal Link
- Field Name: field_internal_link
- Label: Internal Link
- Type: Entity Reference to Content
- Field Widget: Entity Browser field
- Selection Display: Rendered Entity using
Entity Browser Selected Entity - Required: Yes
- Tooltip Text: None
- Cardinality: 1
- Translatable:
Override Link Button Title
- Field Name: field_button_text (existing field from borderless card - reuses an existing field; easier for developers to identify the correct field; has the correct character limit)
- Label: Override Link Button Title
- Type: Text (plain)
- Required: No
- Max characters: 100
- Tooltip Text: If left blank, pages' card title will display. If no card title, pages' browser title will display instead.
- Cardinality: 1
- Translatable: No
Button Alt Text
Should output "" when no alt text is entered
- Field Name: field_button_alt (existing field from borderless card)
- Label: Link Button Alt Text
- Type: Text (plain)
- Required: No
- Max characters: 125
- Tooltip Text: A description of the link button destination for use by screen readers. Suggest using the title of the destination page.
- Cardinality: 1
- Translatable: No
Form Display
- Link
- Override Link Button Title
- Link Button Alt Text
NCIDS Link Button External
- Display Name: NCIDS Link Button External
- Machine-readable Name: ncids_link_button_external
- Description: Button linking to external content.
- Translatable: No
Common Fields
- External Link Display
- Label: External Link Display
Local Fields
External Link
- Field Name: field_external_link
- Label: Link
- Type: Text (plain)
- Required: Yes
- Tooltip Text: Enter the full URL starting with https://
- Cardinality: 1
- Translatable: No
Link Button Title
- Field Name: field_button_text (existing field from borderless card - reuses an existing field; easier for developers to identify the correct field; has the correct character limit)
- Label: Link Button Title
- Type: Text (plain)
- Required: Yes
- Max characters:t 100
- Tooltip Text: Title of link destination.
- Cardinality: 1
- Translatable: No
Button Alt Text
Should output "" when no alt text is entered
- Field Name: field_button_alt (existing field from borderless card)
- Label: Button Alt Text
- Type: Text (plain)
- Required: No
- Max characters: 125
- Tooltip Text: A description of the call to action destination for use by screen readers. Suggest using the title of the destination page.
- Cardinality: 1
- Translatable: No
Form Display
- Link
- External Link Display
- Link Button Title
- Link Button Alt Text