Skip to content

Commit

Permalink
docs(pencil): typo fix on demo/index.js
Browse files Browse the repository at this point in the history
wrong custom element name
`badge` -> `table`
  • Loading branch information
sun-mota committed Oct 21, 2024
1 parent 3943034 commit 242d4ec
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion demo/index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { AuroTable } from '../src/auro-table.js';

AuroTable.register('custom-badge');
AuroTable.register('custom-table');
58 changes: 29 additions & 29 deletions demo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@
The index.md file is a compiled document. No edits should be made directly to this file.
README.md is created by running `npm run build:docs`.
This file is generated based on a template fetched from `./docs/partials/index.md`
-->

-->

# Table

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./description.md) -->
<!-- The below content is automatically added from ./description.md -->
Use the `auro-table` custom element to illustrate non-dynamic tabular data. The auro-table element is responsive, with a flexible layout and an easy-to-use JSON API.
<!-- AURO-GENERATED-CONTENT:END -->

<!-- AURO-GENERATED-CONTENT:END -->

## Use Cases

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./useCases.md) -->
<!-- The below content is automatically added from ./useCases.md -->
The `<auro-table>` element should be used in situations where users may:

* Show static tabluar data
<!-- AURO-GENERATED-CONTENT:END -->

<!-- AURO-GENERATED-CONTENT:END -->

## Example(s)

<div class="exampleWrapper">
Expand All @@ -35,12 +35,12 @@ The `<auro-table>` element should be used in situations where users may:
]'>My morning schedule
</auro-table>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/basic.html -->

<!-- The below code snippet is automatically added from ./../../apiExamples/basic.html -->

```html
<auro-table
columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
Expand All @@ -50,11 +50,11 @@ The `<auro-table>` element should be used in situations where users may:
{"": "Team meeting", "Wednesday": "10:00am" },
{"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
]'>My morning schedule
</auro-table>
```
<!-- AURO-GENERATED-CONTENT:END -->
</auro-accordion>

</auro-table>
```
<!-- AURO-GENERATED-CONTENT:END -->
</auro-accordion>

## React and Svelte support

```js
Expand All @@ -66,11 +66,11 @@ const data=JSON.stringify([
{"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
])

<auro-table nowrap columnHeaders={headers} componentData={data}>Default text</auro-table>
```

Having a closing statement about your example helps to really complete the thought with your reader.
<auro-table nowrap columnHeaders={headers} componentData={data}>Default text</auro-table>
```

Having a closing statement about your example helps to really complete the thought with your reader.

## WC Style Sheets support

For use cases where the general design of the Auro Table is needed, but the component is unseable, please use the [.auro_table](https://alaskaairlines.github.io/WebCoreStyleSheets/#utility-auro-css-#{$scope}.auro_table) styles from the Web Core Style Sheets library.
Expand All @@ -97,9 +97,9 @@ For use cases where the general design of the Auro Table is needed, but the comp
<td>with two columns</td>
</tr>
</tbody>
</table>
```

</table>
```

## Recommended Use and Version Control

There are two important parts of every Auro component. The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element. The class is exported and then used as part of defining the Web Component. When importing this component as described in the <a href="#install">install</a> section, the class is imported and the `auro-table` custom element is defined automatically.
Expand Down Expand Up @@ -127,12 +127,12 @@ This will create a new custom element that you can use in your HTML that will fu
]'>My morning schedule
</custom-table>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/customTable.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/customTable.html -->

<!-- The below code snippet is automatically added from ./../../apiExamples/customTable.html -->

```html
<custom-table
columnHeaders='["","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]'
Expand All @@ -142,7 +142,7 @@ This will create a new custom element that you can use in your HTML that will fu
{"": "Team meeting", "Wednesday": "10:00am" },
{"": "Morning workout", "Monday": "8:00am", "Tuesday": "8:00am", "Wednesday": "8:00am", "Thursday": "8:00am", "Friday": "8:00am" }
]'>My morning schedule
</custom-table>
```
<!-- AURO-GENERATED-CONTENT:END -->
</custom-table>
```
<!-- AURO-GENERATED-CONTENT:END -->
</auro-accordion>
2 changes: 1 addition & 1 deletion demo/index.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 242d4ec

Please sign in to comment.