redth-org / AndHUD

Android Progress HUD and Dialog helpers for Xamarin.Android apps!
Apache License 2.0
179 stars 69 forks source link

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

Closed beeradmoore closed 1 year ago

beeradmoore commented 1 year ago

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

Docs

:arrow_heading_down: 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);

:new: 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);

:boom: Does this PR introduce a breaking change?

Nope.

:bug: Recommendations for testing

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

:memo: Links to relevant issues/docs

README.md

:thinking: Checklist before submitting