Skip to content

Commit

Permalink
Merge pull request #400 from digitalnsw/documentation-update
Browse files Browse the repository at this point in the history 
Minor documentation updates.
  • Loading branch information
@oisa
oisa authored Jun 6, 2024
2 parents 79ce03d + 2dfe42d commit 5428ec8
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 72 deletions.
33 changes: 0 additions & 33 deletions src/components/button/blank.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,39 +49,6 @@ page: true
{{>_button type="button" style="light" text="Full Width" isFullWidth=true}}
</div>

<!-- Brand Light Outline -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="light-outline" text="Link"}}
{{>_button-link url="#" style="light-outline" text="Link icon" icon="upload"}}
{{>_button type="button" style="light-outline" text="Button"}}
{{>_button type="button" style="light-outline" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="light-outline" text="Input"}}
{{>_button-input type="button" style="light-outline" text="Disabled" isDisabled=true}}
{{>_button type="button" style="light-outline" text="Full Width" isFullWidth=true}}
</div>

<!-- White -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="white" text="Link"}}
{{>_button-link url="#" style="white" text="Link icon" icon="upload"}}
{{>_button type="button" style="white" text="Button"}}
{{>_button type="button" style="white" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="white" text="Input"}}
{{>_button-input type="button" style="white" text="Disabled" isDisabled=true}}
{{>_button type="button" style="white" text="Full Width" isFullWidth=true}}
</div>

<!-- White Outline -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="white-outline" text="Link"}}
{{>_button-link url="#" style="white-outline" text="Link icon" icon="upload"}}
{{>_button type="button" style="white-outline" text="Button"}}
{{>_button type="button" style="white-outline" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="white-outline" text="Input"}}
{{>_button-input type="button" style="white-outline" text="Disabled" isDisabled=true}}
{{>_button type="button" style="white-outline" text="Full Width" isFullWidth=true}}
</div>

<!-- Danger -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="danger" text="Link"}}
Expand Down
35 changes: 1 addition & 34 deletions src/components/button/theme.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ page: true
{{>_button-input type="button" style="dark-outline" text="Disabled" isDisabled=true}}
{{>_button type="button" style="dark-outline" text="Full Width" isFullWidth=true}}
</div>

<!-- Brand Dark Outline Solid -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="dark-outline-solid" text="Link"}}
Expand All @@ -51,39 +51,6 @@ page: true
{{>_button type="button" style="light" text="Full Width" isFullWidth=true}}
</div>

<!-- Brand Light Outline -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="light-outline" text="Link"}}
{{>_button-link url="#" style="light-outline" text="Link icon" icon="upload"}}
{{>_button type="button" style="light-outline" text="Button"}}
{{>_button type="button" style="light-outline" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="light-outline" text="Input"}}
{{>_button-input type="button" style="light-outline" text="Disabled" isDisabled=true}}
{{>_button type="button" style="light-outline" text="Full Width" isFullWidth=true}}
</div>

<!-- White -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="white" text="Link"}}
{{>_button-link url="#" style="white" text="Link icon" icon="upload"}}
{{>_button type="button" style="white" text="Button"}}
{{>_button type="button" style="white" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="white" text="Input"}}
{{>_button-input type="button" style="white" text="Disabled" isDisabled=true}}
{{>_button type="button" style="white" text="Full Width" isFullWidth=true}}
</div>

<!-- White Outline -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="white-outline" text="Link"}}
{{>_button-link url="#" style="white-outline" text="Link icon" icon="upload"}}
{{>_button type="button" style="white-outline" text="Button"}}
{{>_button type="button" style="white-outline" text="Button link" icon="download" icon-after="true"}}
{{>_button-input type="button" style="white-outline" text="Input"}}
{{>_button-input type="button" style="white-outline" text="Disabled" isDisabled=true}}
{{>_button type="button" style="white-outline" text="Full Width" isFullWidth=true}}
</div>

<!-- Danger -->
<div class="nsw-list nsw-list--8 nsw-m-bottom-sm">
{{>_button-link url="#" style="danger" text="Link"}}
Expand Down
8 changes: 4 additions & 4 deletions src/components/callout/_guidance.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ layout: blank-layout.hbs
</ul>

<h3>When to avoid</h3>
<p>Callouts should be used sparingly to maintain effectiveness, consider weaving the information into the introduction or as part of the instructions you're creating. </p>
<p>Callouts should be used sparingly to maintain effectiveness, consider weaving the information into the introduction or as part of the instructions you're creating.</p>
<p>Do not:</p>
<ul>
<li>add multiple callout boxes to a topic. This dilutes the importance of the callout and distracts the user. </li>
<li>create a callout with content that is not relevant to the user as your reader might then ignore furutre callouts</li>
<li>add multiple callout boxes to a topic. This dilutes the importance of the callout and distracts the user.</li>
<li>create a callout with content that is not relevant to the user as your reader might then ignore future callouts.</li>
</ul>

<h2>How this component works</h2>
<p>Callouts can contain an icon, a title and a message. Callouts should be short, easy to scan, informative and clear. </p>
<p>Callouts can contain an icon, a title and a message. Callouts should be short, easy to scan, informative and clear.</p>

<h2>Accessibility</h2>
<p>All components are responsive and meet WCAG 2.1 AA accessibility guidelines.</p>
2 changes: 1 addition & 1 deletion src/docs/content/design/theming.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,4 +308,4 @@ meta-index: true
<li><strong> Brand Accent</strong> can be selected from any row from your chosen colour sets (row 02 and 03 recommended).</li>
</ul>
<p>Guidance on applying your new brand colours in Figma can be found on the <strong>Colour</strong> page of the <a href="/docs/content/design/figma-ui-kit.html">Figma UI Kit</a>.</p>
<p>As core styles and components inherit colours from the base colour theme, changing a brand colour will automatically filter down to all instances where that colour is used. Alternatively, colour instances can be updated on an individual basis as required. Where possible, it is indicated in the guidance on the <strong>Components</strong> page.</p>
<p>As core styles and components inherit colours from the base colour theme, changing a brand colour will automatically filter down to all instances where that colour is used. Alternatively, colour instances can be updated on an individual basis within the chosen colour sets as required. Where possible, it is indicated in the guidance on the <strong>Components</strong> page.</p>
2 changes: 2 additions & 0 deletions src/global/handlebars/layouts/layout.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta property="og:type" content="website">
<meta property="og:image" content="https://digitalnsw.github.io/nsw-design-system/nsw-og-image.jpg">
{{#if meta-index}}
<meta name="description" content="{{meta-description}}" />
{{else}}
Expand Down
Binary file added src/nsw-og-image.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5428ec8

Please sign in to comment.