Compare commits

...

5 Commits

Author SHA1 Message Date
d67b7a1c67 Merge pull request 'dev' (#4) from dev into main
All checks were successful
Publish to npm / publish (push) Successful in 26s
Reviewed-on: #4
2025-02-26 00:35:55 +00:00
638a730b19
0.1.2
Some checks are pending
Publish to npm / publish (push) Waiting to run
2025-02-26 11:27:41 +11:00
39ca9ddd14
fix: update documentation links in README and components to reflect correct URLs for Vue 3
Some checks failed
Publish to npm / publish (push) Has been cancelled
2025-02-26 11:27:27 +11:00
8af79850e3
fix: update documentation link in SingleDatePicker component to reflect v-model usage
All checks were successful
Publish to npm / publish (push) Successful in 32s
2025-02-26 10:48:37 +11:00
9890221c85
fix: update documentation links in SingleDatePicker and SingleWeekPicker components to point to Vue 3 guide 2025-02-26 10:04:00 +11:00
5 changed files with 28 additions and 14 deletions

View File

@ -44,7 +44,7 @@ const date = ref(new Date())
```
For more information and live demo, refer to [Datenels documentation](https://datenel.js.org/guide/vue/gettingstart.html).
For more information and live demo, refer to [Datenels documentation](https://datenel.js.org/guide/vue3/gettingstart.html).
## Supported Components & Props

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "datenel-vue3",
"version": "0.1.1",
"version": "0.1.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "datenel-vue3",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT",
"devDependencies": {
"@types/node": "^22.13.5",

View File

@ -1,6 +1,6 @@
{
"name": "datenel-vue3",
"version": "0.1.1",
"version": "0.1.2",
"type": "module",
"scripts": {
"dev": "vite",

View File

@ -3,7 +3,7 @@
* @name SingleDatePicker
* @description A panel that allows users to select a date.
* @component
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html}
*/
export default {
name: 'SingleDatePicker',
@ -38,7 +38,7 @@ const props = defineProps({
* - `hoverColor`: The hover color of the panel, including the hover background color of the date.
* - `reversedColor`: The reversed color of the panel, including the text color of the selected date.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html#colorscheme}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html#colorscheme}
*
* @default { mainColor: '#000000', accentColor: '#000000', borderColor: '#e0e0e0', hoverColor: '#00000017', reversedColor: '#ffffff' }
*/
@ -61,7 +61,7 @@ const props = defineProps({
* that it will not effect to the screen reader, but the screen reader will still read the
* date in the users language.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html#localization}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html#localization}
* @default navigator.language
*/
localization: {
@ -75,7 +75,7 @@ const props = defineProps({
* date programmatically, including situations like provide a default value or control the selected
* date by parent component.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html#value}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html#modelvalue-a-k-a-v-model}
*
* @example new Date(2025, 0, 1)
* @default undefined (the panel will be in read-only mode)
@ -92,7 +92,7 @@ const props = defineProps({
*
* The parameter will be ignored if the array length is not 2.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html#availablerange}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html#availablerange}
*
* @example [new Date(2025, 0, 1), new Date(2025, 11, 31)]
* @example [new Date(2025, 0, 1), null]
@ -110,7 +110,7 @@ const props = defineProps({
* that the close button is not visible, but can be read by screen reader. The close
* button for the screen reader is only available when this prop is not `undefined`.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleDatePicker.html#onclose-void}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleDatePicker.html#close-void}
*
* @default undefined
*/

View File

@ -3,7 +3,7 @@
* @name SingleWeekPicker
* @description A panel that allows users to select a week.
* @component
* @see {@link https://datenel.js.org/guide/vue/components/SingleWeekPicker.html}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleWeekPicker.html}
*/
export default {
name: 'SingleDatePicker',
@ -46,7 +46,7 @@ const props = defineProps({
* - `hoverColor`: The hover color of the panel, including the hover background color of the date.
* - `reversedColor`: The reversed color of the panel, including the text color of the selected date.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleWeekPicker.html#colorscheme}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleWeekPicker.html#colorscheme}
*
* @default { mainColor: '#000000', accentColor: '#000000', borderColor: '#e0e0e0', hoverColor: '#00000017', reversedColor: '#ffffff' }
*/
@ -69,7 +69,7 @@ const props = defineProps({
* that it will not effect to the screen reader, but the screen reader will still read the
* date in the users language.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleWeekPicker.html#localization}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleWeekPicker.html#localization}
* @default navigator.language
*/
localization: {
@ -81,12 +81,26 @@ const props = defineProps({
*
* @description The model value of the component.
*
* @see {@link https://datenel.js.org/guide/vue/components/SingleWeekPicker.html#modelvalue}
* @see {@link https://datenel.js.org/guide/vue3/components/SingleWeekPicker.html#modelvalue-a-k-a-v-model}
*/
modelValue: {
type: Object as () => SingleWeekPickerModelValue,
required: false,
},
/**
* Event handler when the panel is closed.
* @description User requires to close the panel without select a specific date. Note
* that the close button is not visible, but can be read by screen reader. The close
* button for the screen reader is only available when this prop is not `undefined`.
*
* @see {@link https://datenel.js.org/guide/vue3/components/SingleWeekPicker.html#close-void}
*
* @default undefined
*/
close: {
type: Function,
required: false,
}
})
const { colorScheme, localization } = toRefs(props)