-
Notifications
You must be signed in to change notification settings - Fork 97
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
Add labels option to calendar range #375
base: ryszard.support_for_calendar_ranges
Are you sure you want to change the base?
Add labels option to calendar range #375
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we don't have a task in the backlog for this change, so please add the task, or if it's there just link it to the PR.
The functionality works well, I've just added two suggestions to change description and the order of arguments.
@@ -16,12 +16,15 @@ | |||
#' @param end_placeholder Text visible in the end calendar input when nothing is inputted. | |||
#' @param min Minimum allowed value in both calendars. | |||
#' @param max Maximum allowed value in both calendars. | |||
#' @param start_label Label text in the start calendar. | |||
#' @param end_label Label text in the end calendar. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about changing the descriptions to 'Label to be displayed with the start calendar' and 'Label to be displayed with the end calendar'?
#' | ||
#' @rdname calendar_range | ||
#' @export | ||
#' | ||
calendar_range <- function(input_id, type = "date", start_value = NULL, end_value = NULL, | ||
start_placeholder = NULL, end_placeholder = NULL, min = NA, max = NA) { | ||
start_placeholder = NULL, end_placeholder = NULL, min = NA, max = NA, | ||
start_label = NULL, end_label = NULL) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've checked that in the majority of inputs we keep the order of arguments the same as in basic shiny inputs, this is: id, label, value/choices. How about putting the labels after the input_id argument?
Short description (with a reference to an issue).
This PR adds users an opportunity to add label(s) about the calendar_range input fields, as for now it is quite complicated to add labels above start and end calendars fields precisely.
In general, to existing
calendar_range
function added two argumentsstart_label
andend_label
The example app showcasing has been also completed.
examples/calendar_range
DoD
Major project work has a corresponding task. If there’s no task for what you are doing, create it. Each task needs to be well defined and described.
Change has been tested (manually or with automated tests), everything runs correctly and works as expected. No existing functionality is broken.
No new error or warning messages are introduced.
All interaction with a semantic functions, examples and docs are written from the perspective of the person using or receiving it. They are understandable and helpful to this person.
If the change affects code or repo sctructure, README, documentation and code comments should be updated.
All code has been peer-reviewed before merging into any main branch.
All changes have been merged into the main branch we use for development (develop).
Continuous integration checks (linter, unit tests) are configured and passed.
Unit tests added for all new or changed logic.
All task requirements satisfied. The reviewer is responsible to verify each aspect of the task.
Any added or touched code follows our style-guide.