Skip to content

Commit

Permalink
Add some description for DateInput
Browse files Browse the repository at this point in the history
  • Loading branch information
xiongmao86 committed May 1, 2023
1 parent 3b3b4ca commit f633a46
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
41 changes: 22 additions & 19 deletions packages/docs/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
"epicmaxLink": "Visit Epicmax web-site",
"newsBannerText": " \uD83D\uDD25\uD83D\uDD25\uD83D\uDD25 Hi there, we're celebrating our launch on Product Hunt this week! \uD83D\uDE80 We'd love to get your feedback and support! \uD83D\uDE4F",
"newsBannerLink": "Visit the launch page",
"bannerText": ["expert", "s", "available in", "to build and launch your product"]
"bannerText": [ "expert", "s", "available in", "to build and launch your product" ]
}
},
"api": {
Expand Down Expand Up @@ -223,7 +223,14 @@
"groupBy": "When `options` prop is an object, this key will be used to group up options. Can be string (path to the key) or function of type: `(option) => option.group`",
"grow": "Take all container width",
"immediateValidation": "Sets the validation to be performed when the component is mounted",
"anchorSelector": "Anchor CSS selector instead of passing slot"
"anchorSelector": "Anchor CSS selector instead of passing slot",
"ariaSwitchViewLabel": "The aria-label of the \"switch view\" button",
"ariaToggleDropdownLabel": "The aria-label of the \"toggle dropdown list\" button",
"autoPlacement": "If dropdown doesn't fit viewport, it will be placed automatically to fit viewport",
"closeOnClickOutside": "Dropdown will be closed when clicked outside dropdown content and anchor",
"cursor": "Dropdown will be rendered relative to cursor position",
"isContentHoverable": "If true, dropdown content will be hoverable",
"leftIcon": "Sets the icon position to the left."
}
},
"VaBadge": {
Expand Down Expand Up @@ -991,7 +998,6 @@
"splitTo": "Sets a vue navigation link in a split component.",
"splitHref": "Sets a native navigation link in a split component.",
"icon": "Applies a custom icon in the dropdown section.",
"leftIcon": "Sets the icon position to the left.",
"hideIcon": "Hide icon (when `split` is disabled).",
"openedIcon": "Applies a custom icon in the dropdown section when the dropdown is opened.",
"placement": "Sets the placement of the dropdown content. [More about placements](/ui-elements/dropdown#placement-and-offset)",
Expand All @@ -1003,14 +1009,9 @@
"trigger": "Action that will open and close dropdown.",
"preventOverflow": "If true, dropdown will be teleported to target ignoring `overflow: hidden` on relative position elements.",
"stickToEdges": "Dropdown will not be rendered outside of viewport. It will be moved in opposite direction.",
"isContentHoverable": "If true, dropdown content will be hoverable",
"innerAnchorSelector": "Anchor CSS selector inside passed slot.",
"hoverOutTimeout": "Time in `ms` after mouse leave dropdown before it will be closed",
"hoverOverTimeout": "Time in `ms` after mouse enter dropdown before it will be opened",
"cursor": "Dropdown will be rendered relative to cursor position",
"closeOnAnchorClick": "Dropdown will be closed when anchor is clicked",
"closeOnClickOutside": "Dropdown will be closed when clicked outside dropdown content and anchor",
"autoPlacement": "If dropdown doesn't fit viewport, it will be placed automatically to fit viewport"
"hoverOverTimeout": "Time in `ms` after mouse enter dropdown before it will be opened"
},
"events": {
"click": "Emitted when user clicks on button.",
Expand Down Expand Up @@ -1210,7 +1211,15 @@
"ariaLabel": "The aria-label of the input",
"ariaNextPeriodLabel": "The aria-label of the \"next period\" button",
"ariaPreviousPeriodLabel": "The aria-label of the \"previous period\" button",
"ariaResetLabel": "The aria-label of the \"reset\" button"
"ariaResetLabel": "The aria-label of the \"reset\" button",
"ariaSelectedDateLabel": "The aria-label of the input of the component",
"background": "The color name of the backgound color",
"closeOnAnchorClick": "Dropdown will be closed when anchor is clicked",
"closeOnContentClick": "Dropdown will be closed when clicked inside dropdown content",
"delimiter": "The delimiter used when turning model value to string",
"hoverOutTimeout": "Time in `ms` after mouse leave dropdown before it will be closed",
"hoverOverTimeout": "Time in `ms` after mouse enter dropdown before it will be opened",
"keepAnchorWidth": "If true, dropdown content will have exact same width as anchor"
},
"events": {
"clear": "Emitted if select value has been cleared",
Expand Down Expand Up @@ -1382,8 +1391,7 @@
"focused": "Applies focus style",
"canBeFocused": "If false, then input can not be focused using mouse or keyboard",
"icon": "Sets an icon. The default icon position is on the right",
"requiredMark": "Adds required mark to the label",
"leftIcon": "Sets the icon position to the left"
"requiredMark": "Adds required mark to the label"
},
"events": {},
"methods": {},
Expand Down Expand Up @@ -1452,7 +1460,7 @@
"ariaPreviousLabel": "The aria-label of previous button.",
"ariaSlideOfLabel": "The aria-label of the slide.",
"contain": "The image is scaled to maintain its aspect ratio while fitting within the carousel's content box.",
"crossorigin":"Proxies the `crossorigin` attribute to the image of the component [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/img#attr-crossorigin)[[target=_blank]].",
"crossorigin": "Proxies the `crossorigin` attribute to the image of the component [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/img#attr-crossorigin)[[target=_blank]].",
"decoding": "Proxies the `decoding` attribute to the image of the component [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/img#attr-decoding)[[target=_blank]].",
"draggable": "Proxies the `draggable` attribute to the image of the component [MDN](https://developer.mozilla.org/docs/Web/HTML/Global_attributes/draggable)[[target=_blank]].",
"fetchpriority": "Proxies the `fetchpriority` attribute to the image of the component [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/img#attr-fetchpriority)[[target=_blank]].",
Expand Down Expand Up @@ -1483,14 +1491,9 @@
"VaDropdown": {
"props": {
"innerAnchorSelector": "Anchor CSS selector inside passed slot",
"autoPlacement": "If dropdown doesn't fit viewport, it will be placed automatically to fit viewport",
"closeOnAnchorClick": "Dropdown will be closed when anchor is clicked",
"closeOnClickOutside": "Dropdown will be closed when clicked outside dropdown content and anchor",
"closeOnContentClick": "Dropdown will be closed when clicked inside dropdown content",
"cursor": "Dropdown will be rendered relative to cursor position",
"hoverOutTimeout": "Time in `ms` after mouse leave dropdown before it will be closed",
"hoverOverTimeout": "Time in `ms` after mouse enter dropdown before it will be opened",
"isContentHoverable": "If true, dropdown content will be hoverable",
"keepAnchorWidth": "If true, dropdown content will have exact same width as anchor",
"offset": "Dropdown content will be moved by main and cross axis according to current `placement`",
"placement": "Dropdown content will be placed on `placement` side of anchor",
Expand Down Expand Up @@ -5274,4 +5277,4 @@
}
}
}
}
}
2 changes: 1 addition & 1 deletion packages/ui/src/components/va-date-input/VaDateInput.vue
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ export default defineComponent({
disabled: props.disabled,
tabindex: props.disabled ? -1 : 0,
value: valueText.value,
ariaLabel: props.label || tp('selectedDate'),
ariaLabel: props.label || tp(props.ariaSelectedDateLabel),
ariaRequired: props.requiredMark,
ariaDisabled: props.disabled,
ariaReadOnly: props.readonly,
Expand Down

0 comments on commit f633a46

Please sign in to comment.