@ebay/ui-core-react/ebay-lightbox-dialog/README.md

Skin components build off React

# EbayLightboxDialog

## Demo

[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-lightbox-dialog--default)

## Usage

```jsx
<EbayLightboxDialog open a11yClosetext="Close">
    <EbayDialogHeader>Heading</EbayDialogHeader>
    <p>Body content</p>
    <EbayDialogFooter>Footer</EbayDialogFooter>
</EbayLightboxDialog>
```

## Attributes

| Name                | Type    | Stateful | Required | Description                                                                                                                                                                                                               |
| ------------------- | ------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `open`              | Boolean | Yes      | No       | Whether dialog is open.                                                                                                                                                                                                   |
| `mode`              | String  | No       | No       | Can be `default`, `mini`.                                                                                                                                                                                                 |
| `focus`             | String  | No       | No       | An id for an element which will receive focus when the drawer opens (defaults to close button).                                                                                                                           |
| `a11yCloseText`     | String  | No       | Yes      | A11y text for close button and mask.                                                                                                                                                                                      |
| `animated`          | Boolean | Yes      | No       | Renders the dialog with an animation. Note that the dialog will always be present in the DOM                                                                                                                              |
| `bannerImgSrc`      | String  | No       | No       | Image source for the expressive variant                                                                                                                                                                                   |
| `bannerImgPosition` | String  | No       | No       | Position of the image within the given bounds using the CSS `background-position` property. Options include [keywords, lengths, and edge distances](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position) |

## Events

| Event     | Data | Description                      |
| --------- | ---- | -------------------------------- |
| `onOpen`  |      | Trigggered when dialog is opened |
| `onClose` |      | Triggered when dialog is closed  |

## EbayDialogHeader

Will render a header content for the dialog. Will always render the header element even if this is not present

## EbayDialogFooter

Will render the footer content for the dialog. If not present then will not have any footer.

## EbayDialogPreviousButton

Will render the previous icon button. The icon can be overwritten with the `icon` attribute