Skip to content
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

v1.0 rc #27

Merged
merged 28 commits into from
Jul 18, 2023
Merged

v1.0 rc #27

merged 28 commits into from
Jul 18, 2023

Conversation

blackfalcon
Copy link
Member

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is, and anything that describes the before/after state of the project.

This is the summary PR for releasing the v1.0 version of auro-toast.

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

This commit adds all the new resources created
from the Auro WC Generator.

Changes to be committed:
modified:   .github/CONTRIBUTING.md
modified:   .github/ISSUE_TEMPLATE/blueprint.md
new file:   .github/ISSUE_TEMPLATE/bug_report.yml
new file:   .github/ISSUE_TEMPLATE/feature_request.yml
new file:   .github/ISSUE_TEMPLATE/general-support.yml
modified:   .github/ISSUE_TEMPLATE/publish_component.md
modified:   .github/settings.yml
new file:   .github/workflows/codeql.yml
new file:   .github/workflows/testPublish.yml
modified:   .gitignore
new file:   .husky/_/husky.sh
new file:   .husky/commit-msg
new file:   .husky/pre-commit
modified:   .npmignore
modified:   .stylelintrc
modified:   NOTICE
modified:   README.md
new file:   apiExamples/basic.html
new file:   commitlint.config.js
new file:   demo/apiExamples.md
new file:   demo/demo.md
new file:   demo/index.html
new file:   docs/api.md
new file:   docs/partials/apiExamples.md
new file:   docs/partials/demo.md
new file:   docs/partials/description.md
new file:   docs/partials/readmeAddlInfo.md
new file:   docs/partials/useCases.md
new file:   docs/upstream.md
new file:   index.js
new file:   package-lock.json
new file:   package.json
new file:   packageScripts/postinstall.mjs
new file:   rollup.config.mjs
new file:   scripts/generateDocs.js
new file:   scripts/postCss.js
new file:   scripts/pre-commit.mjs
new file:   scripts/staticStyles-template.js
new file:   src/auro-toast.js
new file:   src/style.scss
new file:   test/auro-toast.test.js
new file:   tsconfig.json
new file:   web-test-runner.config.mjs
Changes to be committed:
modified:   .github/CODEOWNERS
This commit completely implement the toaster.js feature
that will manage the experience of multiple toasts.

Changes to be committed:
modified:   README.md
modified:   apiExamples/basic.html
modified:   apiExamples/error.html
new file:   apiExamples/multipleToasts.html
modified:   apiExamples/success.html
renamed:    demo/toggleToast.js -> demo/addToast.js
modified:   demo/apiExamples.md
modified:   demo/demo.md
modified:   demo/index.html
modified:   docs/api.md
modified:   docs/partials/demo.md
modified:   docs/partials/description.md
modified:   docs/partials/useCases.md
modified:   package-lock.json
modified:   package.json
modified:   src/auro-toast.js
new file:   src/auro-toaster.js
new file:   src/style-toaster.scss
modified:   src/style.scss
modified:   test/auro-toast.test.js
This commit will allow users to tab anywhere inside
the toast when dismissing.

Changes to be committed:
modified:   src/auro-toast.js
modified:   src/style-toaster.scss
modified:   src/style.scss
this commit will remove the dependency @open-wc/testing-karma, since we don't use it anymore

Changes to be committed:
modified:   package-lock.json
modified:   package.json
this commit adds indiviual examples for the properties the toast supports

Changes to be committed:
new file:   apiExamples/noIcon.html
new file:   apiExamples/variant.html
new file:   apiExamples/visible.html
modified:   demo/apiExamples.md
modified:   docs/partials/apiExamples.md
this commit adds some code to better the example for the dynamic toasts section and cleans up the custom element section so it works and shows correctly

Changes to be committed:
modified:   demo/demo.md
modified:   demo/index.html
modified:   docs/partials/demo.md
this commit takes care of the following:
removes the usage of an ID on a element in the toast and replaces it with a class
removes styles for button element since there is a class that wraps around the button and can take care of the styles there

Changes to be committed:
modified:   src/auro-toast.js
modified:   src/style.scss
modified:   test/auro-toast.test.js
this commit creates the api.html file to help review the apiExmaples.md file

Changes to be committed:
new file:   demo/api.html
this commit adds aria-live="polite" to the auro-toast, so the screen reader captures the toast and reads that it is visible

Changes to be committed:
modified:   src/auro-toast.js
this commit adds scripts needed to perform showing the toast when clicking on the buttons

Changes to be committed:
modified:   demo/api.html
modified:   demo/apiExamples.md
modified:   demo/index.html
modified:   docs/api.md
modified:   src/auro-toast.js
this commit adds the script for toaster so the mutliple toast section in the demo works correctly.

Changes to be committed:
modified:   demo/index.html
scripts/generateDocs.js Dismissed Show resolved Hide resolved
Changes to be committed:
modified:   README.md
modified:   apiExamples/basic.html
modified:   apiExamples/error.html
modified:   apiExamples/multipleToasts.html
modified:   apiExamples/variant.html
modified:   apiExamples/visible.html
modified:   demo/apiExamples.md
modified:   demo/demo.md
modified:   docs/partials/apiExamples.md
modified:   docs/partials/demo.md
modified:   docs/partials/description.md
modified:   docs/partials/useCases.md
Changes to be committed:
modified:   src/auro-toast.js
Changes to be committed:
modified:   scripts/staticStyles-template.js
Changes to be committed:
modified:   .github/settings.yml
Changes to be committed:
deleted:    .github/ISSUE_TEMPLATE/blueprint.md
deleted:    .github/ISSUE_TEMPLATE/dev-story.md
deleted:    .github/ISSUE_TEMPLATE/feature_request.md
deleted:    .github/ISSUE_TEMPLATE/general-support.md
deleted:    .github/ISSUE_TEMPLATE/publish_component.md
deleted:    .github/ISSUE_TEMPLATE/release_candidate.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - thanks for making those editorial changes!

@blackfalcon blackfalcon linked an issue Jul 6, 2023 that may be closed by this pull request
39 tasks
@blackfalcon
Copy link
Member Author

Chrome mobile experience

Screen Shot 2023-07-10 at 3 21 02 PM

Safari

Screen Shot 2023-07-10 at 3 22 32 PM

Firefox

Screen Shot 2023-07-10 at 3 23 18 PM

@blackfalcon
Copy link
Member Author

Lighthouse A11Y score. Issue is NOT related to the component, has to do with the coloring of the code examples.

Screen Shot 2023-07-10 at 3 24 55 PM

Copy link
Contributor

@jordanjones243 jordanjones243 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to run a build to update docs, an event type was changed.

.github/workflows/codeql.yml Show resolved Hide resolved
demo/addToast.js Outdated Show resolved Hide resolved
rollup.config.mjs Outdated Show resolved Hide resolved
Changes to be committed:
new file:   .github/workflows/autoAssign.yml
demo/index.html Outdated Show resolved Hide resolved
demo/index.js Show resolved Hide resolved
docs/partials/apiExamples.md Outdated Show resolved Hide resolved
this commit is to follow the new js model

Changes to be committed:
modified:   .gitignore
renamed:    demo/addToast.js -> apiExamples/showToast.js
modified:   demo/api.html
new file:   demo/api.js
modified:   demo/apiExamples.md
modified:   demo/index.html
new file:   demo/index.js
modified:   docs/api.md
modified:   package.json
modified:   rollup.config.mjs
new file:   scripts/prepExampleFiles.js
this commit adds the auto-generated script for the showToast function in all the examples so users are aware this is used for all buttons on this page

Changes to be committed:
modified:   apiExamples/showToast.js
modified:   demo/apiExamples.md
modified:   docs/partials/apiExamples.md
@blackfalcon blackfalcon merged commit b0ba570 into main Jul 18, 2023
4 checks passed
@blackfalcon blackfalcon deleted the v1.0-rc branch July 18, 2023 23:01
@blackfalcon
Copy link
Member Author

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auro Toast final release
4 participants