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

feat(DateField): add component's description in README #35

Merged
merged 10 commits into from
Jan 26, 2024
Merged

Conversation

Arucard89
Copy link
Contributor

DATAUI-2000

@gravity-ui-bot
Copy link
Contributor

Preview is ready.

src/components/DateField/README.md Outdated Show resolved Hide resolved
src/components/DateField/README.md Outdated Show resolved Hide resolved
src/components/DateField/README.md Outdated Show resolved Hide resolved
| aria-labelledby | The control's `aria-labelledby` attribute | `string` | |
| autoFocus | The control's `autofocus` attribute | `boolean` | |
| className | The control's wrapper class name | `string` | |
| defaultValue | The control's default value, used when the component is not controlled | `DateTime` | |
Copy link
Contributor

Choose a reason for hiding this comment

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

This property used to set initial value in case of uncontrolled using. But it is not required

Copy link
Contributor Author

@Arucard89 Arucard89 Jan 25, 2024

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

There is no need in "Optional" word here, because we have column with this information

| rightContent | User`s node rendered after the input node and clear button | `React.ReactNode` | |
| size | The size of the control | `"s"` `"m"` `"l"` `"xl"` | `"m"` |
| style | Sets inline style for the element. | `CSSProperties` | |
| timeZone | Sets the time zone | `string` | |
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be great if we add some link with all timezones and their formats

Copy link
Contributor Author

@Arucard89 Arucard89 Jan 25, 2024

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Could u add this link here?

@Arucard89
Copy link
Contributor Author

Made all fixes

@Arucard89 Arucard89 merged commit e8a015e into main Jan 26, 2024
3 checks passed
@Arucard89 Arucard89 deleted the DATAUI-2000 branch January 26, 2024 07:09
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.

3 participants