Giter Site home page Giter Site logo

contextual-element-identifier's Introduction

contextual-element-identifier

Library of context-based element identification and search

Setup

$ npm install contextual-element-identifier

Concept and Usage

This library aims to uniquely identify HTML elements on web pages and web applications based on context.
The library generates an xpath based on the identifier and gets an element.
For example, even if the target page changes while scraping, you can get the target element.

Import

import * as CEI from 'contextual-element-identifier';

or

const CEI = require('contextual-element-identifier');

ElementIdentifier Creation

identifierFromElement()

export const identifierFromElement = (
  element: Element,
  ignoreClassNames: string[] = [],
  document: Document = window.document
): ElementIdentifier

ElementIdentifier is a pure object and can be easily serialized.
ignoreClassNames is a class name that ignores its existence when identifying an element. For example, if you set active, the library does not distinguish between elements with and without.

Find elements from ElementIdentifier

getElement()

export const getElement = (
  identifier: ElementIdentifier,
  ignoreClassNames: string[] = [],
  document: Document = window.document
): Element | undefined

Gets an element that exactly matches the ElementIdentifier. If it does not exist, it returns undefined.

findElements()

export const findElements = (
  identifier: ElementIdentifier,
  ignoreClassNames: string[] = [],
  document: Document = window.document
): Element[]

Acquires the target element or its candidate based on ElementIdentifier.

findElementsWithPredicate()

export const findElementsWithPredicate = (
  identifier: ElementIdentifier,
  predicate: (element: Element) => boolean,
  document: Document = window.document
): Element[]

The basic behavior is the same as for findElements().
You can filter target elements by predicate.

Get siblings elements from ElementIdentifier

getSiblingsElements()

export const getSiblingsElements = (
  identifier: ElementIdentifier | ElementIdentifier[],
  ignoreClassNames: string[] = [],
  document: Document = window.document
): Element[]

Gets sibling elements of one or more ElementIdentifiers.
If the repeating element is the target element (such as li, td, etc...), that condition takes precedence.
If multiple ElementIdentifiers are given, behavior will be to exclude different conditions based on the first ElementIdentifiers.

getMultipleSiblingsElements()

export const getMultipleSiblingsElements = (
  identifiers: ElementIdentifier[][],
  ignoreClassNames: string[] = [],
  document: Document = window.document
): (Element | undefined)[][]

Get sibling elements of multiple elements based on whether they belong to the same ancestor element. If there is no sibling element in the ancestor element, undefined is inserted.
If there is no common ancestor, returns the result of getSiblingsElements() for each.

evaluateXPath()

export const evaluateXPath = (
  xpath: string,
  root: Node = window.document,
  document: Document = window.document
): Element[]

Performs an xpath expression.

contextual-element-identifier's People

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

originalexe

contextual-element-identifier's Issues

Trouble using this package from npm

Hello,

First of all, thanks for maintaining this package, it is exactly what I need. That said, I am having trouble making use of it. I tried two ways, and both got me nowhere.

1.) In CodeSandbox, I tried to import the package, but it says it does not exist (even though it was successfully added as a dependency)

2.) Locally with webpack, the result is the same. I can successfully npm install the library, but the export I get is undefined:

import cei from 'contextual-element-identifier';

console.log(cei); // returns undefined

I would appreciate any hints.

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.