Skip to content

[nitpick] This JSDoc comment is too brief. Consider explaining the purpose of the TimeScale component and describing key properties like the event handlers and their usage. #191

@ukorvl

Description

@ukorvl

[nitpick] This JSDoc comment is too brief. Consider explaining the purpose of the TimeScale component and describing key properties like the event handlers and their usage.

 * Props for the TimeScale component, which provides control over the time scale of a chart.
 * The TimeScale component allows customization of the visible time range, logical range, and other
 * time scale options, as well as handling events related to changes in these ranges or the component's size.
 *
 * Properties:
 * - `onVisibleTimeRangeChange` (optional): A callback triggered when the visible time range changes.
 *   Receives the new time range as an argument.
 * - `onVisibleLogicalRangeChange` (optional): A callback triggered when the visible logical range changes.
 *   Receives the new logical range as an argument.
 * - `onSizeChange` (optional): A callback triggered when the size of the time scale changes.
 *   Receives the new size as an argument.
 * - `visibleRange` (optional): Specifies the initial visible time range for the time scale.
 * - `visibleLogicalRange` (optional): Specifies the initial visible logical range for the time scale.
 * - `options` (optional): Configuration options for the time scale, such as appearance and behavior.
 * - `children` (optional): React children to render within the TimeScale component.

Originally posted by @Copilot in #190 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationChanges to documentation filesenhancementImprovements or new featureseslintChanges related to ESLint configuration or rulesgood first issueA good first issue for new contributors

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions