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(Timeline): timelineitem add trigger on click #3512

Merged
merged 4 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ exports[`TimelineItem Component > props.content works fine 1`] = `
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
PengYYYYY marked this conversation as resolved.
Show resolved Hide resolved
>
<!---->
<!---->
Expand Down Expand Up @@ -48,7 +48,7 @@ exports[`TimelineItem Component > props.label works fine 1`] = `
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand All @@ -75,7 +75,7 @@ exports[`TimelineItem Component > slots.content works fine 1`] = `
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down Expand Up @@ -118,7 +118,7 @@ exports[`TimelineItem Component > slots.label works fine 1`] = `
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down
38 changes: 0 additions & 38 deletions src/timeline/time-line-item-props.ts

This file was deleted.

4 changes: 3 additions & 1 deletion src/timeline/timeline-item-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default {
},
/** 时间轴颜色,内置 `primary/warning/error/default` 四种色值,可传入 16 进制颜色码或 RGB 颜色值. */
dotColor: {
type: String,
type: String as PropType<TdTimelineItemProps['dotColor']>,
default: 'primary',
},
/** 标签文本内容,可完全自定义 */
Expand All @@ -35,4 +35,6 @@ export default {
},
/** 是否处在加载状态 */
loading: Boolean,
/** 点击时触发 */
onClick: Function as PropType<TdTimelineItemProps['onClick']>,
};
10 changes: 7 additions & 3 deletions src/timeline/timeline-item.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { defineComponent, inject } from 'vue';
import TimeLineItemProps from './time-line-item-props';
import omit from 'lodash/omit';
import props from './timeline-item-props';
import { usePrefixClass } from '../hooks/useConfig';
import { useContent, useTNodeJSX } from '../hooks/tnode';
import { TimelineInjectKey, DEFAULT_PROVIDER } from './hooks';
Expand All @@ -10,7 +11,7 @@ const DEFAULT_THEME = ['default', 'primary', 'success', 'warning', 'error'];
export default defineComponent({
name: 'TTimelineItem',
props: {
...TimeLineItemProps,
...props,
index: {
type: Number,
},
Expand Down Expand Up @@ -44,6 +45,9 @@ export default defineComponent({
}
return '';
};
const handleClick = (e: MouseEvent) => {
props.onClick?.({ e, item: omit(props, ['index']) });
};

return () => {
const { mode, theme, itemsStatus, reverse } = TimelineProvider.value;
Expand All @@ -59,7 +63,7 @@ export default defineComponent({
}

return (
<li class={[`${COMPONENT_NAME.value}`, `${getPositionClassName(props.index)}`]}>
<li class={[`${COMPONENT_NAME.value}`, `${getPositionClassName(props.index)}`]} onClick={handleClick}>
{mode === 'alternate' && labelNode && (
<div class={[`${COMPONENT_NAME.value}__label`, `${COMPONENT_NAME.value}__label--${mode}`]}>{labelNode}</div>
)}
Expand Down
17 changes: 12 additions & 5 deletions src/timeline/timeline.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

name | type | default | description | required
-- | -- | -- | -- | --
labelAlign | String | left | label info placement。optionsleft/right/alternate/top/bottom | N
layout | String | vertical | time line layout。optionshorizontal/vertical | N
mode | String | alternate | The position relationship between the label and the content text, 'alternate' is displayed on both sides of the axis, and 'same' is displayed on the same side。optionsalternate/same | N
labelAlign | String | left | label info placement。options: left/right/alternate/top/bottom | N
layout | String | vertical | time line layout。options: horizontal/vertical | N
mode | String | alternate | The position relationship between the label and the content text, 'alternate' is displayed on both sides of the axis, and 'same' is displayed on the same side。options: alternate/same | N
reverse | Boolean | false | \- | N
theme | String | default | optionsdefault/dot | N
theme | String | default | options: default/dot | N

### TimelineItem Props

Expand All @@ -19,5 +19,12 @@ content | String / Slot / Function | - | Typescript:`string \| TNode`。[see m
dot | Slot / Function | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
dotColor | String | primary | Typescript:`string` | N
label | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
labelAlign | String | - | optionsleft/right/top/bottom | N
labelAlign | String | - | options: left/right/top/bottom | N
loading | Boolean | - | Whether it is in the loading state | N
onClick | Function | | Typescript:`(context: { e: MouseEvent; item: TdTimelineItemProps }) => void`<br/>trigger on click | N

### TimelineItem Events

name | params | description
-- | -- | --
click | `(context: { e: MouseEvent; item: TdTimelineItemProps })` | trigger on click
7 changes: 7 additions & 0 deletions src/timeline/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,10 @@ dotColor | String | primary | 时间轴颜色,内置 `primary/warning/error/de
label | String / Slot / Function | - | 标签文本内容,可完全自定义。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
labelAlign | String | - | 标签信息相对于时间轴的位置,在 `mode='alternate'` 时生效,优先级高于 `Timeline.labelAlign`。可选项:left/right/top/bottom | N
loading | Boolean | - | 是否处在加载状态 | N
onClick | Function | | TS 类型:`(context: { e: MouseEvent; item: TdTimelineItemProps }) => void`<br/>点击时触发 | N

### TimelineItem Events

名称 | 参数 | 描述
-- | -- | --
click | `(context: { e: MouseEvent; item: TdTimelineItemProps })` | 点击时触发
4 changes: 4 additions & 0 deletions src/timeline/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,8 @@ export interface TdTimelineItemProps {
* 是否处在加载状态
*/
loading?: boolean;
/**
* 点击时触发
*/
onClick?: (context: { e: MouseEvent; item: TdTimelineItemProps }) => void;
}
10 changes: 5 additions & 5 deletions test/unit/snap/__snapshots__/csr.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -170820,7 +170820,7 @@ exports[`csr snapshot test > csr test ./src/timeline/_example/customContent.vue
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down Expand Up @@ -170857,7 +170857,7 @@ exports[`csr snapshot test > csr test ./src/timeline/_example/customContent.vue
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down Expand Up @@ -170894,7 +170894,7 @@ exports[`csr snapshot test > csr test ./src/timeline/_example/customContent.vue
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down Expand Up @@ -170931,7 +170931,7 @@ exports[`csr snapshot test > csr test ./src/timeline/_example/customContent.vue
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down Expand Up @@ -172198,7 +172198,7 @@ exports[`csr snapshot test > csr test ./src/timeline/_example/theme.vue 1`] = `
class="t-timeline-item__wrapper"
>
<div
class="t-timeline-item__dot t-timeline-item__dot--default"
class="t-timeline-item__dot t-timeline-item__dot--primary"
>
<!---->
<!---->
Expand Down
Loading
Loading