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

Update examples in README to match what is available in AndHUD 2.0 #54

Merged
merged 1 commit into from Mar 29, 2023

Conversation

beeradmoore
Copy link
Contributor

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Docs

⤵️ What is the current behavior?

Default example in README says this

//Show a simple status message with an indeterminate spinner
AndHUD.Shared.Show(myActivity, "Status Message", MaskType.Clear);

//Show a progress with a filling circle representing the progress amount
AndHUD.Shared.ShowProgress(myActivity, "Loading… 60%", 60);

🆕 What is the new behavior (if this is a feature change)?

But that won't work, you either need to set maskType: to the first example or set progress to -1 which is the default. The second example does not work at all as ShowProgress was removed, instead you should use Show with the progress argument.

//Show a simple status message with an indeterminate spinner
AndHUD.Shared.Show(myActivity, "Status Message", -1, MaskType.Clear);

//Show a progress with a filling circle representing the progress amount
AndHUD.Shared.Show(myActivity, "Loading… 60%", 60);

💥 Does this PR introduce a breaking change?

Nope.

🐛 Recommendations for testing

Copying examples from README into a new project and see how IDE responds to the methods.

📝 Links to relevant issues/docs

README.md

🤔 Checklist before submitting

  • All projects build
  • Follows style guide lines
  • Relevant documentation was updated
  • Rebased onto current develop

@Cheesebaron Cheesebaron merged commit 19f5c2e into redth-org:main Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants