Skip to content

Commit

Permalink
Add Banner docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hanbyul-here committed Jul 24, 2024
1 parent 266ffbe commit 508bd47
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/content/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,25 @@ strings: {
}
```

### Banner

`Banner` object allows you to display a site-wide banner that sits atop your application. To create a banner, you need to provide four attributes (one optional) as outlined below.

```
expiryDate: Date,
actionUrl: string,
contents: string,
type?: BannerType
```

| Option | Type | Description| Example|
|---|---|---|---|
| expiryDate | Date | The date and time when the banner expires. (ISO 8601 format) | '2024-08-03T12:00:00-04:00'|
| actionUrl | string | The URL that will be triggered when the user clicks on the banner. | 'stories/emit-and-aviris-3' |
| contents | string | The text content to display in the banner. | 'Read the new data insight on using EMIT and AVIRIS-3 for monitoring large methane emission events.' |
| type | enum('info', 'warning') |The type of information delivered by the banner, which determines its background color. | 'info'|


## Meta files

_There is currently not a lot of customization that can be done to meta images._
Expand Down

0 comments on commit 508bd47

Please sign in to comment.