-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: write custom docs page for brand-background component
- Loading branch information
1 parent
123f94b
commit f5ce74e
Showing
4 changed files
with
54 additions
and
1 deletion.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
import { Meta, Title, Subtitle, Stories } from "@storybook/blocks"; | ||
import LinkTo from "@storybook/addon-links/react"; | ||
import * as ComponentStories from "./brand-background.stories.ts"; | ||
|
||
<Meta of={ComponentStories} /> | ||
|
||
<Title>Brand Background</Title> | ||
|
||
**This component expects the background image to be served by the app using the design system.** | ||
|
||
To use this component, take the following steps: | ||
|
||
1. Go to <a href="../?path=/docs/brand-logos--docs#marque-white">Marque White</a> and download the image. | ||
|
||
2. Serve the file from your app. This will depend on the technology your app is written in. | ||
|
||
3. Optionally, use the provided CSS custom property to configure the path to the image. The default is `/images/marque-white.svg`. | ||
|
||
```css | ||
.iati-brand-background { | ||
--background-image: url("PATH_TO_IMAGE"); | ||
} | ||
``` | ||
|
||
4. Apply the appropriate classes to your html elements, using the example below. | ||
|
||
<Stories /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters