dsfr4drupal-1.x-dev/components/modal/modal.component.yml

name: DSFR - Modal
description: The modal allows you to focus the user's attention exclusively on a task or an element of information, without losing the context of the current page. This component requires user action in order to be opened or closed.
status: stable
group: DSFR
props:
  properties:
    attributes:
      type: Drupal\Core\Template\Attribute
      title: Attributes
    button_label:
      type: string
      title: Button label
      description: 'By default: "Close", or the translated string in another language.'
    button_title:
      type: string
      title: Button title attribute
      description: 'By default: "Close", or the translated string in another language.'
    concealing_backdrop:
      type: boolean
      title: Close modal when user clicks outside the modal
      default: true
    html_id:
      type: string
      title: HTML identifier
    html_tag:
      type: string
      title: HTML tag
      default: dialog
      enum:
        - dialog
        - div
    icon:
      type: string
      title: Icon
      description: 'Example: "checkbox-line"'
    icon_size:
      type: string
      title: Icon size
      default: md
      enum:
        - sm
        - md
        - lg
    size:
      type: string
      title: Size
      default: md
      enum:
        - sm
        - md
        - lg
    title:
      type: string
      title: Title
    title_attributes:
      type: Drupal\Core\Template\Attribute
      title: Title attributes
    title_tag:
      type: string
      title: Title HTML tag
      default: h1
slots:
  modal_content:
    title: Modal content
  modal_footer:
    title: Modal footer
libraryOverrides:
  dependencies:
    - dsfr4drupal/component.modal