Refactor #3922 - For Slider
parent
0f6803631f
commit
a760c56aef
|
@ -9,6 +9,49 @@
|
||||||
*/
|
*/
|
||||||
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
||||||
|
|
||||||
|
export declare type SliderPassThroughOptionType = SliderPassThroughAttributes | ((options: SliderPassThroughMethodOptions) => SliderPassThroughAttributes) | null | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom passthrough(pt) option method.
|
||||||
|
*/
|
||||||
|
export interface SliderPassThroughMethodOptions {
|
||||||
|
props: SliderProps;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom passthrough(pt) options.
|
||||||
|
* @see {@link SliderProps.pt}
|
||||||
|
*/
|
||||||
|
export interface SliderPassThroughOptions {
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to the root's DOM element.
|
||||||
|
*/
|
||||||
|
root?: SliderPassThroughOptionType;
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to the range's DOM element.
|
||||||
|
*/
|
||||||
|
range?: SliderPassThroughOptionType;
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to the handle's DOM element.
|
||||||
|
*/
|
||||||
|
handle?: SliderPassThroughOptionType;
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to the start handler's DOM element.
|
||||||
|
*/
|
||||||
|
startHandler?: SliderPassThroughOptionType;
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to the end handler's DOM element.
|
||||||
|
*/
|
||||||
|
endHandler?: SliderPassThroughOptionType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom passthrough attributes for each DOM elements
|
||||||
|
*/
|
||||||
|
export interface SliderPassThroughAttributes {
|
||||||
|
[key: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Custom slide end event.
|
* Custom slide end event.
|
||||||
* @see {@link SliderEmits.slideend}
|
* @see {@link SliderEmits.slideend}
|
||||||
|
@ -74,6 +117,11 @@ export interface SliderProps {
|
||||||
* Used to define a string that labels the element.
|
* Used to define a string that labels the element.
|
||||||
*/
|
*/
|
||||||
'aria-label'?: string | undefined;
|
'aria-label'?: string | undefined;
|
||||||
|
/**
|
||||||
|
* Uses to pass attributes to DOM elements inside the component.
|
||||||
|
* @type {SliderPassThroughOptions}
|
||||||
|
*/
|
||||||
|
pt?: SliderPassThroughOptions;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
<template>
|
<template>
|
||||||
<div :class="containerClass" @click="onBarClick">
|
<div :class="containerClass" @click="onBarClick" v-bind="ptm('root')">
|
||||||
<span class="p-slider-range" :style="rangeStyle"></span>
|
<span class="p-slider-range" :style="rangeStyle" v-bind="ptm('range')"></span>
|
||||||
<span
|
<span
|
||||||
v-if="!range"
|
v-if="!range"
|
||||||
class="p-slider-handle"
|
class="p-slider-handle"
|
||||||
|
@ -18,6 +18,7 @@
|
||||||
:aria-labelledby="ariaLabelledby"
|
:aria-labelledby="ariaLabelledby"
|
||||||
:aria-label="ariaLabel"
|
:aria-label="ariaLabel"
|
||||||
:aria-orientation="orientation"
|
:aria-orientation="orientation"
|
||||||
|
v-bind="ptm('handle')"
|
||||||
></span>
|
></span>
|
||||||
<span
|
<span
|
||||||
v-if="range"
|
v-if="range"
|
||||||
|
@ -36,6 +37,7 @@
|
||||||
:aria-labelledby="ariaLabelledby"
|
:aria-labelledby="ariaLabelledby"
|
||||||
:aria-label="ariaLabel"
|
:aria-label="ariaLabel"
|
||||||
:aria-orientation="orientation"
|
:aria-orientation="orientation"
|
||||||
|
v-bind="ptm('startHandler')"
|
||||||
></span>
|
></span>
|
||||||
<span
|
<span
|
||||||
v-if="range"
|
v-if="range"
|
||||||
|
@ -54,15 +56,18 @@
|
||||||
:aria-labelledby="ariaLabelledby"
|
:aria-labelledby="ariaLabelledby"
|
||||||
:aria-label="ariaLabel"
|
:aria-label="ariaLabel"
|
||||||
:aria-orientation="orientation"
|
:aria-orientation="orientation"
|
||||||
|
v-bind="ptm('endHandler')"
|
||||||
></span>
|
></span>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
|
import BaseComponent from 'primevue/basecomponent';
|
||||||
import { DomHandler } from 'primevue/utils';
|
import { DomHandler } from 'primevue/utils';
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
name: 'Slider',
|
name: 'Slider',
|
||||||
|
extends: BaseComponent,
|
||||||
emits: ['update:modelValue', 'change', 'slideend'],
|
emits: ['update:modelValue', 'change', 'slideend'],
|
||||||
props: {
|
props: {
|
||||||
modelValue: [Number, Array],
|
modelValue: [Number, Array],
|
||||||
|
|
|
@ -0,0 +1,49 @@
|
||||||
|
<template>
|
||||||
|
<DocSectionText v-bind="$attrs"> </DocSectionText>
|
||||||
|
<div class="card flex justify-content-center">
|
||||||
|
<Slider v-model="value" class="w-14rem" />
|
||||||
|
</div>
|
||||||
|
<DocSectionCode :code="code" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export default {
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
value: null,
|
||||||
|
code: {
|
||||||
|
basic: `
|
||||||
|
<Slider v-model="value" class="w-14rem" />`,
|
||||||
|
options: `
|
||||||
|
<template>
|
||||||
|
<div class="card flex justify-content-center">
|
||||||
|
<Slider v-model="value" class="w-14rem" />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export default {
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
value: null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
<\/script>`,
|
||||||
|
composition: `
|
||||||
|
<template>
|
||||||
|
<div class="card flex justify-content-center">
|
||||||
|
<Slider v-model="value" class="w-14rem" />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
import { ref } from 'vue';
|
||||||
|
|
||||||
|
const value = ref(null);
|
||||||
|
<\/script>`
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
|
@ -0,0 +1,8 @@
|
||||||
|
<template>
|
||||||
|
<DocSectionText v-bind="$attrs">
|
||||||
|
<p>{{ $attrs.description }}</p>
|
||||||
|
</DocSectionText>
|
||||||
|
<div class="card">
|
||||||
|
<img class="w-full" src="https://primefaces.org/cdn/primevue/images/pt/wireframe-placeholder.jpg" />
|
||||||
|
</div>
|
||||||
|
</template>
|
|
@ -0,0 +1,41 @@
|
||||||
|
<template>
|
||||||
|
<div class="doc-main">
|
||||||
|
<div class="doc-intro">
|
||||||
|
<h1>Slider Pass Through</h1>
|
||||||
|
</div>
|
||||||
|
<DocSections :docs="docs" />
|
||||||
|
</div>
|
||||||
|
<DocSectionNav :docs="docs" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import DocApiTable from '@/components/doc/DocApiTable.vue';
|
||||||
|
import { getPTOption } from '@/components/doc/helpers/PTHelper.js';
|
||||||
|
import PtDoc from './PTDoc.vue';
|
||||||
|
import PTImage from './PTImage.vue';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
docs: [
|
||||||
|
{
|
||||||
|
id: 'pt.image',
|
||||||
|
label: 'Wireframe',
|
||||||
|
component: PTImage
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'pt.doc.steps',
|
||||||
|
label: 'Slider PT Options',
|
||||||
|
component: DocApiTable,
|
||||||
|
data: getPTOption('Slider')
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'pt.demo',
|
||||||
|
label: 'Demo',
|
||||||
|
component: PtDoc
|
||||||
|
}
|
||||||
|
]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
|
@ -1,5 +1,5 @@
|
||||||
<template>
|
<template>
|
||||||
<DocComponent title="Vue Slider Component" header="Slider" description="Slider is a component to provide input with a drag handle." :componentDocs="docs" :apiDocs="['Slider']" />
|
<DocComponent title="Vue Slider Component" header="Slider" description="Slider is a component to provide input with a drag handle." :componentDocs="docs" :apiDocs="['Slider']" :ptTabComponent="ptComponent" />
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
|
@ -11,7 +11,7 @@ import RangeDoc from '@/doc/slider/RangeDoc';
|
||||||
import StepDoc from '@/doc/slider/StepDoc';
|
import StepDoc from '@/doc/slider/StepDoc';
|
||||||
import StyleDoc from '@/doc/slider/StyleDoc';
|
import StyleDoc from '@/doc/slider/StyleDoc';
|
||||||
import VerticalDoc from '@/doc/slider/VerticalDoc';
|
import VerticalDoc from '@/doc/slider/VerticalDoc';
|
||||||
|
import PTComponent from '@/doc/slider/pt/index.vue';
|
||||||
export default {
|
export default {
|
||||||
data() {
|
data() {
|
||||||
return {
|
return {
|
||||||
|
@ -56,7 +56,8 @@ export default {
|
||||||
label: 'Accessibility',
|
label: 'Accessibility',
|
||||||
component: AccessibilityDoc
|
component: AccessibilityDoc
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
ptComponent: PTComponent
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in New Issue