Safari Developer Library

Developer

SafariReader Class Reference

Options
Deployment Target:

On This Page

SafariReader

Reader is a Safari feature that allows users to read online articles in a continuous, clutter-free view, with no ads or visual distractions. Reader concatenates multipage articles into a single scrolling pane.

Instances of the SafariReader class represent the Reader view.

  • available Property

    A Boolean value that indicates whether the tab can display the Reader view.

    Declaration

    readonly attribute boolean available

    Discussion

    When the Reader view becomes available, a SafariAvailableEvent event is sent. If you need to know when the Reader view becomes available, listen for that event rather than polling this property.

  • Enters the Reader view if it is available; otherwise does nothing.

    Declaration

    void enter ()

  • Exits the Reader if it is visible; otherwise does nothing.

    Declaration

    void exit ()

  • tab Property

    The browser tab that contains the Reader view.

    Declaration

    readonly attribute SafariBrowserTab tab

  • visible Property

    A Boolean value that indicates whether the Reader view is being displayed.

    Declaration

    readonly attribute boolean visible

  • Dispatches a message to the Reader view.

    Declaration

    void dispatchMessage (in DOMString name, in any message)

    Parameters

    name

    The name of the message.

    message

    The body of the message. Optional.