Open Pioneer Trails Packages
    Preparing search index...

    Interface HistoryProps

    Options that specify which map to use. See useMapModelValue.

    When not setting any of these properties on a component, the default map (from the DefaultMapProvider) will be used. If that is not available either, an error will be thrown.

    DefaultMapProvider

    interface HistoryProps {
        buttonProps?: Partial<ButtonProps>;
        map?: MapModel;
        viewDirection: "forward" | "backward";
        [key: `data-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    • CommonComponentProps
    • RefAttributes<HTMLButtonElement>
    • MapModelProps
      • HistoryProps

    Indexable

    • [key: `data-${string}`]: unknown

      Arbitrary data attributes.

      NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

    Index

    Properties

    buttonProps? map? viewDirection

    Properties

    buttonProps?: Partial<ButtonProps>

    Additional properties for the Button element.

    Note that the ToolButton also defines some of these props.

    map?: MapModel

    The map model to use.

    viewDirection: "forward" | "backward"

    The view direction.

    The button will either view forward or view backward depending on this value.

    Settings

    Member Visibility

    On This Page

    Properties