Skip to content

Commit

Permalink
guide lines
Browse files Browse the repository at this point in the history
  • Loading branch information
rachelbt committed Nov 4, 2024
1 parent 6b4ab9a commit b27be04
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 53 deletions.
86 changes: 39 additions & 47 deletions libs/components/src/lib/banner/GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,80 +6,72 @@

```html preview example
<vwc-banner
text="Use Vivid in Your Design"
icon="sparkles-solid"
connotation="announcement"
>
<vwc-button
slot="action-items"
size="condensed"
shape="pill"
href="https://vivid.deno.dev"
target="_blank"
appearance="filled"
connotation="accent"
label="Start Using Vivid Components Now"
icon="chevron-right-line"
icon-trailing
></vwc-button
></vwc-banner>
text="Use Vivid in Your Design"
icon="sparkles-solid"
connotation="announcement"
>
<vwc-button
slot="action-items"
size="condensed"
shape="pill"
href="https://vivid.deno.dev"
target="_blank"
appearance="filled"
connotation="accent"
label="Start Using Vivid Components Now"
icon="chevron-right-line"
icon-trailing
></vwc-button
></vwc-banner>
```

</docs-do>

<docs-do dont>


```html preview example
<vwc-banner
text="Use Vivid in Your Design in all of your design. Fill for designers and for developers as well"
icon="sparkles-solid"
connotation="announcement"
>
<vwc-button
slot="action-items"
size="condensed"
shape="pill"
href="https://vivid.deno.dev"
target="_blank"
appearance="filled"
connotation="accent"
label="Start Now"
icon="chevron-right-line"
icon-trailing
></vwc-button
></vwc-banner>
text="Use Vivid in Your Design in all of your design. Fill for designers and for developers as well"
icon="sparkles-solid"
connotation="announcement"
>
<vwc-button
slot="action-items"
size="condensed"
shape="pill"
href="https://vivid.deno.dev"
target="_blank"
appearance="filled"
connotation="accent"
label="Start Now"
icon="chevron-right-line"
icon-trailing
></vwc-button
></vwc-banner>
```

</docs-do>
</docs-do-dont>


## Connotation

<docs-do-dont no-gutters headline="Use the banner connotation according to its purpose">

<docs-do>

```html preview example
<vwc-banner
text="Operation Successful!"
connotation="success"
>
></vwc-banner>
<vwc-banner text="Operation Successful!" connotation="success"> ></vwc-banner>
```

</docs-do>

<docs-do dont>

```html preview example
<vwc-banner
text="Operation Successful!"
connotation="information"
>
></vwc-banner>
<vwc-banner text="Operation Successful!" connotation="information">
></vwc-banner
>
```

</docs-do>
</docs-do-dont>

6 changes: 0 additions & 6 deletions libs/components/src/lib/banner/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# Banner

Banner displays a prominent message, usually on system level, and provides actions for users to address or dismiss.

It is meant to be used at the top of pages, outside the main content.

## Usage

<vwc-tabs>
Expand Down

0 comments on commit b27be04

Please sign in to comment.