PR: Improvements on Existing Field Articles #318
Merged
Conversation
This file contains 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 commit focused on improving the current documentation for field components: - Added parentheses behind every method name - Corrected ComponentDemo URLs - Gave a more assertive tone in **Best practices** - Addressed Valve errors - Removed extra import statements - Removed commented-out sections - Reorganized the TOC order to reflect the Components Overview page - Significant rewrote the following sections: - **ColorField Color code format** - **PasswordField Password visibility** - **PasswordField Best practices (Password Confirmation)**
bbrennanbasis
requested review from
hyyan,
MatthewHawkins,
nmlynx and
mschned
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| The `TimeField` will, by default, display its information within the UI element based on the locale the browser is configured to. For example, users with United States configurations will see the time displayed with A.M. and P.M. labels, whereas other locales would see the time in 24 hour format. This does not inhibit manipulation of the `LocalTime` object returned by methods from the class, however. | ||
| The value of the time field is always in 24-hour format that includes leading zeros: HH:mm, regardless of the UI field format, which is likely to be selected based on the user's locale (or by the user agent). If the time includes seconds, the format is always HH:mm:ss |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| <JavadocLink type="foundation" location="com/webforj/component/field/PasswordField" top='true'/> | ||
|
|
||
| <ParentLink parent="Field" /> | ||
|
|
||
| The `PasswordField` component provides a way for the user to securely enter a password. The element is presented as a one-line plain text editor control in which the text is obscured so that it cannot be read, usually by replacing each character with a symbol such as the asterisk ("*") or a dot ("•"). This character will vary depending on the user agent and operating system. | ||
| The `PasswordField` component empowers users to enter their passwords confidently, ensuring security and privacy. It elegantly presents itself as a single-line text editor, where each character transforms into an obscured symbol, usually an asterisk ("*") or a dot ("•"), depending on the user agent and operating system. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
|
@bbrennanbasis I will merge this as it is for now, as there are numerous reported issues related to each field article. Please start reviewing them one by one and submit a pull request for each. Don’t hesitate to reach out if you need any help. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR focuses on improving currently existing documentation for field components. Issue #166 is ignored for this PR because it involves creating new content/articles.
Changes
Note
Any corrections and additions needed for the Styling sections are addressed in PR #296.