Skip to content

Commit

Permalink
NumberBox API Review Docs (#52)
Browse files Browse the repository at this point in the history
* Adding spec for NumberBox.

* [PM] Added initial description.

* [PM] Added example headers.

* [DEV] [PM] Added IDL and example code.

* [PM] Fixed IDL formatting.

* [PM] Added formatting example + API and open question.

* [DEV] [PM] Changed CalculationsEnabled to AcceptsCalculation...

and updated custom format example.

* [DEV] Prefix/Suffix updated to PrefixText/SuffixText.

* [PM] Removed header examples as this...

property comes free off TextBox. Updated prefix example to use currency.

* [PM] Updated suffix example to use MB instead of cents.

* [PM] Revised "Is this the right control?" section to improve clarity.

* [PM] Added note on void link.

* [DEV] Changed StripLeadingZeros to AreLeadingZerosTrimmed.

* [DEV] Changed FormatType to FormatKind to align with naming guidelines.

* [DEV] Updated UpDownArrows to UpDownButtons.

* [PM] Revised AutomationProperties.Name to align with revised examples.

* Adding images folder via placeholder file.

* Adding example images.

* [PM] Added example images.

* Deleting image placeholder file.

* [PM] Updated open questions list.

* [PM] Added tentative APIs for decimal precision and rounding.

* [DEV] API IDL updated. Examples todo.

* [PM] Updated examples with revised properties...

and revised "Description."

* [PM] Formatting fix.

* [PM] Updated open questions.

* [PM] Adding open questions.

* [DEV] Added ValueChanged event.

* [PM] Updated open question pictures.

* [PM] [DEV] Added API/notes for Value/Text Changed and Validation.

* [PM] Added clarifying behavioral note for Validation in the context of StepSize + MinValue/MaxValue.

* [PM] Fixing Behavioral Notes formatting.

* [PM] Added events/validation open question.

* [DEV] [PM] Updated validation behavior.

* [PM] Re-prioritized Open Questions.

* [DEV] [PM] Updated StepSize to StepFrequency and added API Notes. Moved old "notes" to Appendix.

* [PM] Adding open questions.

* [DEV] [PM] Added additional validation property + notes...

and changed UpDownButtons property from Boolean to enum.

* [DEV] Updated placement enum.

* [DEV] [PM] Added Decimal Precision notes.

* [DEV] [PM] Added Hyper Scroll notes, enum for Min/Max behavior,

and updated examples with these property updates.

* [DEV] [PM] Updated API Notes with InputScope. Updated open questions.

* Typo.

* [PM] Added Keyboard Stepping API Notes and Inputs and Accessibility section template.

* [DEV] [PM] Added API note on calculating before stepping for all step input methods.

* [DEV] [PM] Added same note on UpDown Buttons.

* [DEV] [PM] Detailed events order in API Notes.

* [DEV] [PM] Added evaluation triggers in API Notes.

* [DEV] [PM] Added EnterTriggersEvaluation property.

* [PM] Highlighted computation support in API Notes > Behavioral Components.

* [PM] Added @mdtauk's open question.

* [DEV] [PM] Updated API to use NumberBoxBasicValidationMode enum...

and updated corresponding behaviors in API Notes.

* Formatting induced typo.

* [DEV] [PM] Updated UpDownButtons to SpinButton to align with Fabric UI.

* [PM] Added open question for styling spin buttons.

* [DEV] [PM] Added Keyboard Navigation.

* [PM] Added Narrator states - Actions to be added.

* [DEV] [PM] Added note about disabling spin button when at min/max.

* [DEV] [PM] Updated events for Value changing/changed.

* [PM] Updated naming/headers/accessibility across examples.

* [DEV] [PM] Removed DoesEnterTriggerEvaluation property and added "Enter" to list of keys that trigger evaluation.

* [PM] Updating spinner button mock up.

* Delete numberbox-updownbuttons.png

* [PM] Updating SpinnerButton mock up.

* [PM] Updated open questions.

* [DEV] [PM] Transitioned formatting to DecimalFormatter and NumberRounder properties + instances.

* [DEV] [PM] Small Narrator update.

* [DEV] Removed class instances of NumberRounder and DecimalFormatter. 

Left aligned properties.

* [DEV] [PM] Removed "=" list of keys to invoke evaluation.

* [DEV] [PM] Updated styling properties.

* [DEV] [PM] Updated Validation + Stepping

* [DEV] [PM] Added division by zero error message.

* [DEV] Aligned dependency properties.

* [DEV] [PM] Added enum for specify sig fig or increment based precision.

* [DEV] Updated dependency properties to match precision selection modes.

* [DEV] [PM] Added note to align hyper drag with WinRT XAML Toolkit's NumericUpDown

and updated open questions.

* [DEV]  Added a "None" option to the NumberRounder enum.

* [DEV] [PM] Added gamepad input notes.

* [DEV] [PM] Formatting issue fixed in gamepad input notes.

* [DEV] [PM] Added Narrator actions.

* [DEV] [PM] Added D&I targets.

* Updating to reflect spin button design changes

* No longer subclassing TextBox

* Typo Fix

* [DEV] [PM] Removed Precision section from API Notes as 

this is now covered by NumberBoxNumberRounder and associated properties.

* [DEV] [PM] Added API note in "Events" that querying Value will trigger evaluation and return NaN if Value is in error state.

* Updated IDL for V1 prototype.

Todo: Draw distinctions between V1 and V2 validation features.
Todo: Add new API examples.

* Updated TODO and Open Questions sections.

* Edit to TODO update.

* Spec suggestions and feedback (#51)

* Spec suggestions and feedback

* BasicValidationMode -> ValidationMode

* Removed Spinner button icon/styling properties.

* Added "Is" prefix to hyper and wrap properties.

* Added HeaderTemplate.

* Added clarity on Stepping with Minimum and Maximum

values and fixed DependancyProperties.

* Removed unneeded names from samples.

* Removed todo on Calculations + Spinner - handled in PR comments.

* Typo fix

Co-Authored-By: Yulia Klein <yulikl@microsoft.com>

* Cleaning up template comment bloat.

* Added description to 'AcceptsCalculation' section.

* Updated SpinnerButton placement name and sample description.

* Adding section headers for formatting and validation.

* Migrated V2 features to dedicated section.

* Removed ValueChanging and related event args.

* Updated SpinButton example, APIs, and details.

* Removed hyper APIs from IDL until V2 implementation.

* Added sample for input validation.

* Formalized documentation remark on input scope.

* Fixed formatting on some API names.

* Quick clean up of to-dos.

* Migrated all non-implementation detail items of

Appendix: Behavior Components to Example descriptions or Remarks.

* [DEV] Removed implementation requirement that requesting Value should force evaluation. On top of not having a ValueChanging event, reading from Value should not be needed. ValueChanged is an appropriate notification to read from an x:Bind connected data source.

* Added called out absent core TextBox properties.

* Delete numberbox-acceptscalculation.png

* Delete numberbox-suffix.png

* Delete numberbox-prefix.png

* Delete numberbox-placeholder-text.png

* Delete numberbox-ipv4-formatting-example.png

* Delete numberbox-spinnerbutton.png

* Updating images to use real art.

* Delete numberbox-basic.png

* Adding real art for SpinButton placement modes.

* Updated images.

* Update NumberBox.md

* NumberBoxValueChangedEventArgs

* Added labeling example.

* Added Recommendation regarding Value vs Text

* [PM] Added hyperscroll back in.

* Added formatting section.

* Delete numberbox-basic.PNG

* Added labeling images.

* Delete numberbox-basic.PNG

* New basic image.

* Delete numberbox-basic.PNG

* [PM] New basic NumberBox image.

* [PM] Removing old basic image.

* [PM] I think I've fixed this image...

* Updated accessible image descriptions.

* Added formatted NumberBox image.

* Delete numberbox-formatted.png

* Added formatted NumberBox image.

* [DEV] AcceptsCalculation -> AcceptsExpression

* [PM] Fixed example indentation.

* Removed scrolling as settable property.

* [PM] Added V2 consideration for configurable calculator engine.

* [PM] Added note that formatted input is allowed.

* [PM] Added Remark bullet describing expression evaluation mechanism.

* Updated "Stepping" section and API references.

Co-authored-by: Kevin Taha <tahakevin@gmail.com>
Co-authored-by: MikeHillberg <18429489+MikeHillberg@users.noreply.github.com>
  • Loading branch information
3 people committed Feb 12, 2020
1 parent 8be6c85 commit 650a578
Show file tree
Hide file tree
Showing 8 changed files with 346 additions and 0 deletions.
346 changes: 346 additions & 0 deletions active/NumberBox/NumberBox.md

Large diffs are not rendered by default.

Binary file added active/NumberBox/images/numberbox-basic.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added active/NumberBox/images/numberbox-formatted.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added active/NumberBox/images/numberbox-header.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 650a578

Please sign in to comment.