-
Notifications
You must be signed in to change notification settings - Fork 1
Modernize docs #79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jordanjones243
wants to merge
1
commit into
dev
Choose a base branch
from
jjones/modernizeDocs/#78
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Modernize docs #79
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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 @@ | ||
| <custom-backtotop>Custom back to top</custom-backtotop> |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1 +1,9 @@ | ||
| <!-- add custom registration content here --> | ||
| ```js | ||
| // Import the class only | ||
| import { AuroBackToTop } from '@aurodesignsystem/auro-backtotop/class'; | ||
|
|
||
| // Register with a custom name if desired | ||
| AuroBackToTop.register('custom-backtotop'); | ||
| ``` | ||
|
|
||
| This will create a new custom element `<custom-backtotop>` that behaves exactly like `<auro-backtotop>`, allowing both to coexist on the same page without interfering with each other. |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| `<auro-backtotop>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of providing a quick and accessible means to jump back to the top of a long content page. | ||
|
|
||
| The component will be hidden while the page Y scroll position is at the top. When scroll down begins the button will display in the bottom right corner of the page. While scrolling down the button will display only an arrow up icon. When scroll up occurs, the button will additionally display any slotted text content. | ||
| The component will be hidden while the page Y scroll position is at the top. When scroll down begins the button will display in the bottom right corner of the page. While scrolling down the button will display only an arrow up icon. |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,64 +1,37 @@ | ||
| <!-- | ||
| 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` | ||
| THIS PAGE'S CONTENT SHOULD BE KEPT MINIMAL. | ||
| ONLY ADD EXAMPLES THAT ARE TRULY NECESSARY FOR THE INDEX PAGE — THE BASIC EXAMPLE IS USUALLY ENOUGH. | ||
| ALL OTHER EXAMPLES SHOULD GO IN THE API DOCUMENTATION. | ||
| --> | ||
|
|
||
| # Backtotop | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## auro-backtotop use cases | ||
|
|
||
| ## Use Cases | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Example(s) | ||
|
|
||
| ### Basic | ||
|
|
||
| <div class="exampleWrapper"> | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basicButtonOnly.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic_button-only.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| </div> | ||
|
|
||
| <auro-accordion alignRight> | ||
| <span slot="trigger">See code</span> | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| </auro-accordion> | ||
|
|
||
| ## Page Content For Demo | ||
| ### Page Content For Demo | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/pageContent.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/page-content.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## 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-backtotop` custom element is defined automatically. | ||
|
|
||
| To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our `AuroBackToTop.register(name)` method and pass in a unique name. | ||
|
|
||
| ```js | ||
| import { AuroBackToTop } from '@aurodesignsystem/auro-backtotop/class'; | ||
|
|
||
| AuroBackToTop.register('custom-backtotop'); | ||
| ``` | ||
|
|
||
| This will create a new custom element that you can use in your HTML that will function identically to the `auro-backtotop` element. | ||
|
|
||
| <!-- <div class="exampleWrapper"> | ||
| <auro-backtotop>Custom back to top</auro-backtotop> | ||
| </div> | ||
|
|
||
| <auro-accordion alignRight> | ||
| <span slot="trigger">See code</span> | ||
|
|
||
| ```html | ||
| <auro-backtotop>Custom back to top</auro-backtotop> | ||
| ``` | ||
|
|
||
| </auro-accordion> --> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (typo): Clarify the lead-in sentence and bullet so they form a grammatically complete construction.
The current lead-in + bullet combination (“The
<auro-backtotop>element should be used in situations where users may:” + “Pages with large amounts of content…”) is grammatically awkward. Consider either:<auro-backtotop>element should be used in situations such as:”or rephrasing the bullet to start with “On pages with large amounts of content…” so the full construction reads smoothly.