effect-playwright
    Preparing search index...

    Interface FrameLocator

    Interface for a Playwright frame locator.

    interface FrameLocator {
        _raw: FrameLocator;
        first: () => Playwright.FrameLocator;
        frameLocator: (selector: string) => Playwright.FrameLocator;
        getByAltText: (
            text: string | RegExp,
            options?: { exact?: boolean },
        ) => Playwright.Locator;
        getByLabel: (
            text: string | RegExp,
            options?: { exact?: boolean },
        ) => Playwright.Locator;
        getByPlaceholder: (
            text: string | RegExp,
            options?: { exact?: boolean },
        ) => Playwright.Locator;
        getByRole: (
            role:
                | "alert"
                | "alertdialog"
                | "application"
                | "article"
                | "banner"
                | "blockquote"
                | "button"
                | "caption"
                | "cell"
                | "checkbox"
                | "code"
                | "columnheader"
                | "combobox"
                | "complementary"
                | "contentinfo"
                | "definition"
                | "deletion"
                | "dialog"
                | "directory"
                | "document"
                | "emphasis"
                | "feed"
                | "figure"
                | "form"
                | "generic"
                | "grid"
                | "gridcell"
                | "group"
                | "heading"
                | "img"
                | "insertion"
                | "link"
                | "list"
                | "listbox"
                | "listitem"
                | "log"
                | "main"
                | "marquee"
                | "math"
                | "meter"
                | "menu"
                | "menubar"
                | "menuitem"
                | "menuitemcheckbox"
                | "menuitemradio"
                | "navigation"
                | "none"
                | "note"
                | "option"
                | "paragraph"
                | "presentation"
                | "progressbar"
                | "radio"
                | "radiogroup"
                | "region"
                | "row"
                | "rowgroup"
                | "rowheader"
                | "scrollbar"
                | "search"
                | "searchbox"
                | "separator"
                | "slider"
                | "spinbutton"
                | "status"
                | "strong"
                | "subscript"
                | "superscript"
                | "switch"
                | "tab"
                | "table"
                | "tablist"
                | "tabpanel"
                | "term"
                | "textbox"
                | "time"
                | "timer"
                | "toolbar"
                | "tooltip"
                | "tree"
                | "treegrid"
                | "treeitem",
            options?: {
                checked?: boolean;
                description?: string | RegExp;
                disabled?: boolean;
                exact?: boolean;
                expanded?: boolean;
                includeHidden?: boolean;
                level?: number;
                name?: string | RegExp;
                pressed?: boolean;
                selected?: boolean;
            },
        ) => Playwright.Locator;
        getByTestId: (testId: string | RegExp) => Playwright.Locator;
        getByText: (
            text: string | RegExp,
            options?: { exact?: boolean },
        ) => Playwright.Locator;
        getByTitle: (
            text: string | RegExp,
            options?: { exact?: boolean },
        ) => Playwright.Locator;
        last: () => Playwright.FrameLocator;
        locator: (
            selectorOrLocator: string | Playwright.Locator | Locator,
            options?: {
                has?: Locator;
                hasNot?: Locator;
                hasNotText?: string | RegExp;
                hasText?: string | RegExp;
            },
        ) => Playwright.Locator;
        nth: (index: number) => Playwright.FrameLocator;
        owner: () => Playwright.Locator;
    }
    Index
    _raw first frameLocator getByAltText getByLabel getByPlaceholder getByRole getByTestId getByText getByTitle last locator nth owner

    Readonly Internal_raw

    _raw: FrameLocator

    The underlying Playwright FrameLocator instance.

    first: () => Playwright.FrameLocator

    Returns locator to the first matching frame.

    CoreFrameLocator.first

    0.1.0

    frameLocator: (selector: string) => Playwright.FrameLocator

    When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.

    CoreFrameLocator.frameLocator

    0.1.0

    getByAltText: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => Playwright.Locator

    Allows locating elements by their alt text.

    CoreFrameLocator.getByAltText

    0.1.0

    getByLabel: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => Playwright.Locator

    Allows locating elements by their label text.

    CoreFrameLocator.getByLabel

    0.1.0

    getByPlaceholder: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => Playwright.Locator

    Allows locating elements by their placeholder text.

    CoreFrameLocator.getByPlaceholder

    0.1.0

    getByRole: (
        role:
            | "alert"
            | "alertdialog"
            | "application"
            | "article"
            | "banner"
            | "blockquote"
            | "button"
            | "caption"
            | "cell"
            | "checkbox"
            | "code"
            | "columnheader"
            | "combobox"
            | "complementary"
            | "contentinfo"
            | "definition"
            | "deletion"
            | "dialog"
            | "directory"
            | "document"
            | "emphasis"
            | "feed"
            | "figure"
            | "form"
            | "generic"
            | "grid"
            | "gridcell"
            | "group"
            | "heading"
            | "img"
            | "insertion"
            | "link"
            | "list"
            | "listbox"
            | "listitem"
            | "log"
            | "main"
            | "marquee"
            | "math"
            | "meter"
            | "menu"
            | "menubar"
            | "menuitem"
            | "menuitemcheckbox"
            | "menuitemradio"
            | "navigation"
            | "none"
            | "note"
            | "option"
            | "paragraph"
            | "presentation"
            | "progressbar"
            | "radio"
            | "radiogroup"
            | "region"
            | "row"
            | "rowgroup"
            | "rowheader"
            | "scrollbar"
            | "search"
            | "searchbox"
            | "separator"
            | "slider"
            | "spinbutton"
            | "status"
            | "strong"
            | "subscript"
            | "superscript"
            | "switch"
            | "tab"
            | "table"
            | "tablist"
            | "tabpanel"
            | "term"
            | "textbox"
            | "time"
            | "timer"
            | "toolbar"
            | "tooltip"
            | "tree"
            | "treegrid"
            | "treeitem",
        options?: {
            checked?: boolean;
            description?: string | RegExp;
            disabled?: boolean;
            exact?: boolean;
            expanded?: boolean;
            includeHidden?: boolean;
            level?: number;
            name?: string | RegExp;
            pressed?: boolean;
            selected?: boolean;
        },
    ) => Playwright.Locator

    Allows locating elements by their ARIA role.

    CoreFrameLocator.getByRole

    0.1.0

    getByTestId: (testId: string | RegExp) => Playwright.Locator

    Allows locating elements by their test id.

    CoreFrameLocator.getByTestId

    0.1.0

    getByText: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => Playwright.Locator

    Allows locating elements that contain given text.

    CoreFrameLocator.getByText

    0.1.0

    getByTitle: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => Playwright.Locator

    Allows locating elements by their title attribute.

    CoreFrameLocator.getByTitle

    0.1.0

    last: () => Playwright.FrameLocator

    Returns locator to the last matching frame.

    CoreFrameLocator.last

    0.1.0

    locator: (
        selectorOrLocator: string | Playwright.Locator | Locator,
        options?: {
            has?: Locator;
            hasNot?: Locator;
            hasNotText?: string | RegExp;
            hasText?: string | RegExp;
        },
    ) => Playwright.Locator

    Finds an element matching the specified selector in the locator's subtree.

    CoreFrameLocator.locator

    0.1.0

    nth: (index: number) => Playwright.FrameLocator

    Returns locator to the n-th matching frame.

    CoreFrameLocator.nth

    0.1.0

    owner: () => Playwright.Locator

    Returns a Locator object pointing to the same iframe as this frame locator.

    CoreFrameLocator.owner

    0.1.0

    Settings
    Member Visibility

    On This Page
    Properties