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.

Sign up for GitHub

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

Jump to bottom

fix(react-scheduler): make timeScaleTickCellComponent property public #3474

Merged
merged 2 commits into from
Jan 17, 2022
Merged

fix(react-scheduler): make timeScaleTickCellComponent property public #3474

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a170c52
fix(react-scheduler): make `timeScaleTickCellComponent` property public
Krijovnick Jan 10, 2022
6ba0224
Merge branch 'master' into public_timeScaleTickCellComponent
Krijovnick Jan 17, 2022
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
14 changes: 14 additions & 0 deletions packages/dx-react-scheduler-material-ui/api/dx-react-scheduler-material-ui.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,11 @@ export namespace DayView {
export type TimeScaleLabelProps = DayView_2.TimeScaleLabelProps;
}

// @public (undocumented)
export namespace DayView {
export type TimeScaleTickCellProps = DayView_2.TimeScaleTickCellProps;
}

// @public (undocumented)
export namespace DayView {
export type DayScaleLayoutProps = DayView_2.DayScaleLayoutProps;
Expand Down Expand Up @@ -420,6 +425,7 @@ export const DayView: React_2.ComponentType<DayViewProps> & {
Layout: React_2.ComponentType<DayView_2.LayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleLayout: React_2.ComponentType<DayView_2.TimeScaleLayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleLabel: React_2.ComponentType<DayView_2.TimeScaleLabelProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleTickCell: React_2.ComponentType<DayView_2.TimeScaleTickCellProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleLayout: React_2.ComponentType<DayView_2.DayScaleLayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleCell: React_2.ComponentType<DayView_2.DayScaleCellProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleRow: React_2.ComponentType<DayView_2.RowProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
Expand All @@ -446,6 +452,7 @@ export interface DayViewProps {
startDayHour?: number;
timeScaleLabelComponent?: React_2.ComponentType<DayView_2.TimeScaleLabelProps>;
timeScaleLayoutComponent?: React_2.ComponentType<DayView_2.TimeScaleLayoutProps>;
timeScaleTickCellComponent?: React_2.ComponentType<DayView_2.TimeScaleTickCellProps>;
timeTableCellComponent?: React_2.ComponentType<DayView_2.TimeTableCellProps>;
timeTableLayoutComponent?: React_2.ComponentType<DayView_2.TimeTableLayoutProps>;
timeTableRowComponent?: React_2.ComponentType<DayView_2.RowProps>;
Expand Down Expand Up @@ -732,6 +739,11 @@ export namespace WeekView {
export type TimeScaleLabelProps = WeekView_2.TimeScaleLabelProps;
}

// @public (undocumented)
export namespace WeekView {
export type TimeScaleTickCellProps = WeekView_2.TimeScaleTickCellProps;
}

// @public (undocumented)
export namespace WeekView {
export type DayScaleLayoutProps = WeekView_2.DayScaleLayoutProps;
Expand Down Expand Up @@ -772,6 +784,7 @@ export const WeekView: React_2.ComponentType<WeekViewProps> & {
Layout: React_2.ComponentType<WeekView_2.LayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleLayout: React_2.ComponentType<WeekView_2.TimeScaleLayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleLabel: React_2.ComponentType<WeekView_2.TimeScaleLabelProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
TimeScaleTickCell: React_2.ComponentType<WeekView_2.TimeScaleTickCellProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleLayout: React_2.ComponentType<WeekView_2.DayScaleLayoutProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleCell: React_2.ComponentType<WeekView_2.DayScaleCellProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
DayScaleRow: React_2.ComponentType<WeekView_2.RowProps & { className?: string; style?: React_2.CSSProperties; [x: string]: any }>;
Expand Down Expand Up @@ -799,6 +812,7 @@ export interface WeekViewProps {
startDayHour?: number;
timeScaleLabelComponent?: React_2.ComponentType<WeekView_2.TimeScaleLabelProps>;
timeScaleLayoutComponent?: React_2.ComponentType<WeekView_2.TimeScaleLayoutProps>;
timeScaleTickCellComponent?: React_2.ComponentType<WeekView_2.TimeScaleTickCellProps>;
timeTableCellComponent?: React_2.ComponentType<WeekView_2.TimeTableCellProps>;
timeTableLayoutComponent?: React_2.ComponentType<WeekView_2.TimeTableLayoutProps>;
timeTableRowComponent?: React_2.ComponentType<WeekView_2.RowProps>;
Expand Down
12 changes: 12 additions & 0 deletions packages/dx-react-scheduler/api/dx-react-scheduler.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,13 @@ export namespace BaseView {
height?: number;
labelComponent: React_2.ComponentType<BaseView.TimeScaleLabelProps>;
showAllDayTitle?: boolean;
tickCellComponent: React_2.ComponentType<BaseView.TimeScaleTickCellProps>;
}
export interface TimeScaleTickCellProps {
endDate?: Date;
endOfGroup?: boolean;
groupingInfo?: Array<Group>;
startDate?: Date;
}
export interface TimeTableCellProps {
children?: React_2.ReactNode;
Expand Down Expand Up @@ -702,6 +709,8 @@ export namespace DayView {
}
export interface TimeScaleLayoutProps extends BaseView.TimeScaleLayoutProps {
}
export interface TimeScaleTickCellProps extends BaseView.TimeScaleTickCellProps {
}
export interface TimeTableCellProps extends BaseView.TimeTableCellProps {
}
export interface TimeTableLayoutProps extends BaseView.TimeTableLayoutProps {
Expand Down Expand Up @@ -1151,6 +1160,7 @@ export interface VerticalViewProps extends CommonViewProps {
startDayHour?: number;
timeScaleLabelComponent: React_2.ComponentType<BaseView.TimeScaleLabelProps>;
timeScaleLayoutComponent: React_2.ComponentType<BaseView.TimeScaleLayoutProps>;
timeScaleTickCellComponent: React_2.ComponentType<BaseView.TimeScaleTickCellProps>;
timeTableLayoutComponent: React_2.ComponentType<BaseView.TimeTableLayoutProps>;
}

Expand Down Expand Up @@ -1214,6 +1224,8 @@ export namespace WeekView {
}
export interface TimeScaleLayoutProps extends BaseView.TimeScaleLayoutProps {
}
export interface TimeScaleTickCellProps extends BaseView.TimeScaleTickCellProps {
}
export interface TimeTableCellProps extends BaseView.TimeTableCellProps {
}
export interface TimeTableLayoutProps extends BaseView.TimeTableLayoutProps {
Expand Down
13 changes: 13 additions & 0 deletions packages/dx-react-scheduler/docs/reference/day-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ endDayHour? | number | 24 | Specifies the end hour of the view time scale. Accep
layoutComponent | ComponentType&lt;[DayView.LayoutProps](#dayviewlayoutprops)&gt; | | A component that renders a day view layout.
timeScaleLayoutComponent | ComponentType&lt;[DayView.TimeScaleLayoutProps](#dayviewtimescalelayoutprops)&gt; | | A component that renders a time scale layout.
timeScaleLabelComponent | ComponentType&lt;[DayView.TimeScaleLabelProps](#dayviewtimescalelabelprops)&gt; | | A component that renders a time scale label.
timeScaleTickCellComponent | ComponentType&lt;[DayView.TimeScaleTickCellProps](#dayviewtimescaletickcellprops)&gt; | | A component that renders a time scale tick.
dayScaleLayoutComponent | ComponentType&lt;[DayView.DayScaleLayoutProps](#dayviewdayscalelayoutprops)&gt; | | A component that renders a day scale layout.
dayScaleCellComponent | ComponentType&lt;[DayView.DayScaleCellProps](#dayviewdayscalecellprops)&gt; | | A component that renders a day scale cell.
dayScaleRowComponent | ComponentType&lt;[DayView.RowProps](#dayviewrowprops)&gt; | | A component that renders a day scale row.
Expand Down Expand Up @@ -96,6 +97,17 @@ formatDate | [FormatterFn](scheduler.md#formatterfn) | A function that formats d
groupingInfo? | Array&lt;[Group](./grouping-panel.md/#group)&gt; | Information about the cell's grouping.
endOfGroup? | boolean | `true` if this cell is last in its group.

### DayView.TimeScaleTickCellProps

Describes properties passed to a component that renders a time scale tick.

Field | Type | Description
------|------|------------
startDate? | Date | Specifies the cell's start time.
endDate? | Date | Specifies the cell's end time.
groupingInfo? | Array&lt;[Group](./grouping-panel.md/#group)&gt; | Information about the cell's grouping.
endOfGroup? | boolean | `true` if this cell is last in its group.

### DayView.DayScaleLayoutProps

Describes properties passed to a component that renders a day scale layout.
Expand Down Expand Up @@ -184,6 +196,7 @@ Name | Properties | Description
DayView.Layout | [DayView.LayoutProps](#dayviewlayoutprops) | A component that renders a day view layout.
DayView.TimeScaleLayout | [DayView.TimeScaleLayoutProps](#dayviewtimescalelayoutprops) | A component that renders a time scale layout.
DayView.TimeScaleLabel | [DayView.TimeScaleLabelProps](#dayviewtimescalelabelprops) | A component that renders a time scale label.
DayView.TimeScaleTickCell | [DayView.TimeScaleTickCellProps](#dayviewtimescaletickcellprops) | A component that renders a time scale tick.
DayView.DayScaleLayout | [DayView.DayScaleLayoutProps](#dayviewdayscalelayoutprops) | A component that renders a day scale layout.
DayView.DayScaleCell | [DayView.DayScaleCellProps](#dayviewdayscalecellprops) | A component that renders a day scale cell.
DayView.DayScaleRow | [DayView.RowProps](#dayviewrowprops) | A component that renders a day scale row.
Expand Down
13 changes: 13 additions & 0 deletions packages/dx-react-scheduler/docs/reference/week-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ endDayHour? | number | 24 | Specifies the end hour of the view time scale. Accep
layoutComponent | ComponentType&lt;[WeekView.LayoutProps](#weekviewlayoutprops)&gt; | | A component that renders a week view layout.
timeScaleLayoutComponent | ComponentType&lt;[WeekView.TimeScaleLayoutProps](#weekviewtimescalelayoutprops)&gt; | | A component that renders a time scale layout.
timeScaleLabelComponent | ComponentType&lt;[WeekView.TimeScaleLabelProps](#weekviewtimescalelabelprops)&gt; | | A component that renders a time scale label.
timeScaleTickCellComponent | ComponentType&lt;[WeekView.TimeScaleTickCellProps](#weekviewtimescaletickcellprops)&gt; | | A component that renders a time scale tick.
dayScaleLayoutComponent | ComponentType&lt;[WeekView.DayScaleLayoutProps](#weekviewdayscalelayoutprops)&gt; | | A component that renders a day scale layout.
dayScaleCellComponent | ComponentType&lt;[WeekView.DayScaleCellProps](#weekviewdayscalecellprops)&gt; | | A component that renders a day scale cell.
dayScaleRowComponent | ComponentType&lt;[WeekView.RowProps](#weekviewrowprops)&gt; | | A component that renders a day scale row.
Expand Down Expand Up @@ -97,6 +98,17 @@ formatDate | [FormatterFn](scheduler.md#formatterfn) | A function that formats d
groupingInfo? | Array&lt;[Group](./grouping-panel.md/#group)&gt; | Information about the cell's grouping.
endOfGroup? | boolean | `true` if this cell is last in its group.

### WeekView.TimeScaleTickCellProps

Describes properties passed to a component that renders a time scale tick.

Field | Type | Description
------|------|------------
startDate? | Date | Specifies the cell's start time.
endDate? | Date | Specifies the cell's end time.
groupingInfo? | Array&lt;[Group](./grouping-panel.md/#group)&gt; | Information about the cell's grouping.
endOfGroup? | boolean | `true` if this cell is last in its group.

### WeekView.DayScaleLayoutProps

Describes properties passed to a component that renders a day scale layout.
Expand Down Expand Up @@ -185,6 +197,7 @@ Name | Properties | Description
WeekView.Layout | [WeekView.LayoutProps](#weekviewlayoutprops) | A component that renders a week view layout.
WeekView.TimeScaleLayout | [WeekView.TimeScaleLayoutProps](#weekviewtimescalelayoutprops) | A component that renders a time scale layout.
WeekView.TimeScaleLabel | [WeekView.TimeScaleLabelProps](#weekviewtimescalelabelprops) | A component that renders a time scale label.
WeekView.TimeScaleTickCell | [WeekView.TimeScaleTickCellProps](#weekviewtimescaletickcellprops) | A component that renders a time scale tick.
WeekView.DayScaleLayout | [WeekView.DayScaleLayoutProps](#weekviewdayscalelayoutprops) | A component that renders a day scale layout.
WeekView.DayScaleCell | [WeekView.DayScaleCellProps](#weekviewdayscalecellprops) | A component that renders a day scale cell.
WeekView.DayScaleRow | [WeekView.RowProps](#weekviewrowprops) | A component that renders a day scale row.
Expand Down
6 changes: 3 additions & 3 deletions packages/dx-react-scheduler/src/types/views/base-view.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ export namespace BaseView {
height?: number;
/** If `true`, the 'All Day' title will be displayed. */
showAllDayTitle?: boolean;
/** A component that renders a time scale cell. */
/** A component that renders a time scale label. */
labelComponent: React.ComponentType<BaseView.TimeScaleLabelProps>;
/** @internal */
/** A component that renders a time scale tick. */
tickCellComponent: React.ComponentType<BaseView.TimeScaleTickCellProps>;
/** @internal */
rowComponent: React.ComponentType<BaseView.RowProps>;
Expand All @@ -122,7 +122,7 @@ export namespace BaseView {
/** A function that formats dates according to the locale. */
formatDate: FormatterFn;
}
/** @internal */
/** Describes properties passed to a component that renders a time scale tick. */
export interface TimeScaleTickCellProps {
/** Specifies the cell's start time. */
startDate?: Date;
Expand Down
2 changes: 2 additions & 0 deletions packages/dx-react-scheduler/src/types/views/day-view.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ export namespace DayView {
export interface TimeScaleLayoutProps extends BaseView.TimeScaleLayoutProps {}
/** Describes properties passed to a component that renders a time scale label. */
export interface TimeScaleLabelProps extends BaseView.TimeScaleLabelProps {}
/** Describes properties passed to a component that renders a time scale tick. */
export interface TimeScaleTickCellProps extends BaseView.TimeScaleTickCellProps {}
/** Describes properties passed to a component that renders a day scale layout. */
export interface DayScaleLayoutProps extends BaseView.DayScaleLayoutProps {}
/** Describes properties passed to a component that renders a day scale cell. */
Expand Down
2 changes: 1 addition & 1 deletion packages/dx-react-scheduler/src/types/views/vertical-view.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface VerticalViewProps extends CommonViewProps {
timeScaleLayoutComponent: React.ComponentType<BaseView.TimeScaleLayoutProps>;
/** A component that renders a time scale label. */
timeScaleLabelComponent: React.ComponentType<BaseView.TimeScaleLabelProps>;
/** @internal */
/** A component that renders a time scale tick. */
timeScaleTickCellComponent: React.ComponentType<BaseView.TimeScaleTickCellProps>;
/** @internal */
timeScaleTicksRowComponent: React.ComponentType<BaseView.RowProps>;
Expand Down
2 changes: 2 additions & 0 deletions packages/dx-react-scheduler/src/types/views/week-view.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ export namespace WeekView {
export interface TimeScaleLayoutProps extends BaseView.TimeScaleLayoutProps {}
/** Describes properties passed to a component that renders a time scale label. */
export interface TimeScaleLabelProps extends BaseView.TimeScaleLabelProps {}
/** Describes properties passed to a component that renders a time scale tick. */
export interface TimeScaleTickCellProps extends BaseView.TimeScaleTickCellProps {}
/** Describes properties passed to a component that renders a day scale layout. */
export interface DayScaleLayoutProps extends BaseView.DayScaleLayoutProps {}
/** Describes properties passed to a component that renders a day scale cell. */
Expand Down