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

feat(timerange): custom weekday labels for TimeRange #2510

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(timerange): custom weekday labels for TimeRange #2510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/calendar/src/TimeRange.tsx
View file
Open in desktop
Expand Up @@ -38,6 +38,7 @@ const InnerTimeRange = ({

weekdayLegendOffset = timeRangeDefaultProps.weekdayLegendOffset,
weekdayTicks,
weekdays = timeRangeDefaultProps.weekdays,

dayBorderColor = timeRangeDefaultProps.dayBorderColor,
dayBorderWidth = timeRangeDefaultProps.dayBorderWidth,
Expand Down Expand Up @@ -121,6 +122,7 @@ const InnerTimeRange = ({
daySpacing,
ticks: weekdayTicks,
firstWeekday,
arrayOfWeekdays: weekdays,
})

const monthLegends = useMonthLegends({
Expand All @@ -137,7 +139,7 @@ const InnerTimeRange = ({
<SvgWrapper width={outerWidth} height={outerHeight} margin={margin} role={role}>
{weekdayLegends.map(legend => (
<text
key={legend.value}
key={`${legend.value}-${legend.x}-${legend.y}`}
transform={`translate(${legend.x},${legend.y}) rotate(${legend.rotation})`}
textAnchor="left"
style={theme.labels.text}
Expand Down
5 changes: 3 additions & 2 deletions packages/calendar/src/compute/timeRange.ts
View file
Open in desktop
Expand Up @@ -303,14 +303,15 @@ export const computeWeekdays = ({
daySpacing,
ticks = [1, 3, 5],
firstWeekday,
arrayOfWeekdays = shiftArray(ARRAY_OF_WEEKDAYS, getFirstWeekdayIndex(firstWeekday)),
arrayOfWeekdays = ARRAY_OF_WEEKDAYS,
}: ComputeWeekdays) => {
const sizes = {
width: cellWidth + daySpacing,
height: cellHeight + daySpacing,
}
const shiftedWeekdays = shiftArray(arrayOfWeekdays, getFirstWeekdayIndex(firstWeekday))
return ticks.map(day => ({
value: arrayOfWeekdays[day],
value: shiftedWeekdays[day],
rotation: direction === 'horizontal' ? 0 : -90,
y: direction === 'horizontal' ? sizes.height * (day + 1) - sizes.height / 3 : 0,
x: direction === 'horizontal' ? 0 : sizes.width * (day + 1) - sizes.width / 3,
Expand Down
9 changes: 9 additions & 0 deletions packages/calendar/src/props.ts
View file
Open in desktop
Expand Up @@ -53,4 +53,13 @@ export const timeRangeDefaultProps = {
square: true,
weekdayLegendOffset: 75,
firstWeekday: 'sunday',
weekdays: [
'Sunday',
'Monday',
'Tuesday',
'Wednesday',
'Thursday',
'Friday',
'Saturday',
] as string[],
} as const
1 change: 1 addition & 0 deletions packages/calendar/src/types.ts
View file
Open in desktop
Expand Up @@ -222,6 +222,7 @@ export type TimeRangeSvgProps = Dimensions & { data: CalendarDatum[] } & Partial
weekdayLegendOffset: number
weekdayTicks: Array<0 | 1 | 2 | 3 | 4 | 5 | 6>
firstWeekday: Weekday
weekdays: string[]
}
>

Expand Down
9 changes: 9 additions & 0 deletions website/src/data/components/time-range/props.ts
View file
Open in desktop
Expand Up @@ -196,6 +196,15 @@ const props: ChartProperty[] = [
max: 100,
},
},
{
key: 'weekdays',
help: 'define labels for weekdays',
flavors: allFlavors,
type: 'Array<string>',
required: false,
defaultValue: defaults.weekdays,
group: 'Weekday',
},
{
key: 'weekdayTicks',
help: 'define weekday tickmarks to show',
Expand Down