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

fix(A11Y-58): add aria-label to timeline marker #39

Merged
merged 2 commits into from
Aug 13, 2024
Merged

fix(A11Y-58): add aria-label to timeline marker #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bc801a
fix(A11Y-58): add aria-label to timeline marker
semarche-kaltura Aug 13, 2024
404d22a
fix(A11Y-58): typescript error
semarche-kaltura Aug 13, 2024
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
23 changes: 17 additions & 6 deletions src/components/marker/timeline-marker.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,24 @@ import * as styles from './timeline-marker.scss';
import type {TimelineMarkerProps} from '../../types/timelineTypes';
import {A11yWrapper} from '@playkit-js/common/dist/hoc/a11y-wrapper';
import {useMemo, useRef, useEffect} from 'preact/hooks';
import {Chapter} from "../../../flow-typed/types/cue-point-option";
import {Chapter} from '../../../flow-typed/types/cue-point-option';

const {
redux: {useSelector}
} = KalturaPlayer.ui;

export const TimelineMarker = (({isDisabled, onMarkerClick, getSeekBarNode, useQuizQuestionMarkerSize, setMarkerRef = () => {}, markerStartTime}: TimelineMarkerProps) => {
const segment: Chapter = useSelector((state: any) => state.seekbar.segments.find((segment: Chapter) => markerStartTime >= segment.startTime && markerStartTime < segment.endTime));
export const TimelineMarker = ({
isDisabled,
onMarkerClick,
getSeekBarNode,
useQuizQuestionMarkerSize,
setMarkerRef = () => {},
markerStartTime,
type
}: TimelineMarkerProps) => {
const segment: Chapter = useSelector((state: any) =>
state.seekbar.segments.find((segment: Chapter) => markerStartTime >= segment.startTime && markerStartTime < segment.endTime)
);
const hoverActive = useSelector((state: any) => {
return segment ? segment.isHovered : state.seekbar.hoverActive;
});
Expand Down Expand Up @@ -46,12 +56,12 @@ export const TimelineMarker = (({isDisabled, onMarkerClick, getSeekBarNode, useQ
};

const onMouseOver = () => {
if(markerRef?.current && !useQuizQuestionMarkerSize && isSeekbarSegmented) {
if (markerRef?.current && !useQuizQuestionMarkerSize && isSeekbarSegmented) {
markerRef.current.style.width = '12px';
markerRef.current.style.height = '12px';
markerRef.current.style.transform = 'translateY(-4px)';
}
}
};

return (
<A11yWrapper onClick={onMarkerClick}>
Expand All @@ -62,6 +72,7 @@ export const TimelineMarker = (({isDisabled, onMarkerClick, getSeekBarNode, useQ
onMouseOver={onMouseOver}
tabIndex={disabled ? -1 : 0}
data-testid="cuePointMarkerContainer"
aria-label={type}
SivanA-Kaltura marked this conversation as resolved.
Show resolved Hide resolved
className={`${useQuizQuestionMarkerSize ? styles.quizQuestionMarkerSize : styles.smallMarker} ${hoverActive ? styles.hover : ''}`}
style={`transform: translateY(${getTransformValue()}px)`}>
<div className={`${styles.marker}`} />
Expand All @@ -71,4 +82,4 @@ export const TimelineMarker = (({isDisabled, onMarkerClick, getSeekBarNode, useQ
}, [disabled, hoverActive, useQuizQuestionMarkerSize, isSeekbarSegmented]);

return renderMarker;
});
};
2 changes: 1 addition & 1 deletion src/components/marker/timeline-preview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ interface TimelinePreviewProps {
moveOnHover?: boolean;
}

const getFramePreviewImgContainerStyle = (thumbnailInfo: ThumbnailInfo | ThumbnailInfo[]) => {
const getFramePreviewImgContainerStyle = (thumbnailInfo: ThumbnailInfo | ThumbnailInfo[]): Record<string, string> => {
if (!thumbnailInfo) {
return {
borderColor: 'transparent'
Expand Down
4 changes: 4 additions & 0 deletions src/timeline-manager.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,9 @@ class TimelineManager {
const setMarkerRef = (node: HTMLDivElement | null) => {
timelineMarkerData.timelineMarkerRef = node;
};
const getTimelineMarkerType = () => {
return timelineMarkerData?.cuePointsData?.[0]?.type;
SivanA-Kaltura marked this conversation as resolved.
Show resolved Hide resolved
};
// create the timeline marker comp
const timeLineMarker: TimeLineMarker = {
time: markerStartTime,
Expand All @@ -262,6 +265,7 @@ class TimelineManager {
isDisabled={timelineMarkerData.isMarkerDisabled}
setMarkerRef={setMarkerRef}
markerStartTime={markerStartTime}
type={getTimelineMarkerType()}
/>
);
}
Expand Down
1 change: 1 addition & 0 deletions src/types/timelineTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export interface TimelineMarkerProps {
useQuizQuestionMarkerSize: boolean;
setMarkerRef: (node: HTMLDivElement | null) => void;
markerStartTime: number;
type: string;
}

export interface TimeLineMarker {
Expand Down
Loading