chrome.readingList

Descripción

Usa la API de chrome.readingList para leer y modificar los elementos de la Lista de lectura.

Permisos

readingList

Para usar la API de Reading List, agrega el permiso "readingList" en el archivo de manifiesto de la extensión:

manifest.json:

{
  "name": "My reading list extension",
  ...
  "permissions": [
    "readingList"
  ]
}

Disponibilidad

Chrome 120 y versiones posteriores MV3 y versiones posteriores

Chrome incluye una lista de lectura ubicada en el panel lateral. Permite a los usuarios guardar páginas web para leerlas más tarde o cuando estén sin conexión. Usa la API de la Lista de lectura para recuperar elementos existentes y agregar o quitar elementos de la lista.

Lista de lectura en la que se muestra una cantidad de artículos
Lista de lectura que muestra una cantidad de artículos

Conceptos y uso

Orden de los elementos

Los elementos de la lista de lectura no están en ningún orden garantizado.

Unicidad del elemento

Los elementos se indexan por URL. Esto incluye el hash y la cadena de consulta.

Casos de uso

En las siguientes secciones, se muestran algunos casos de uso comunes de la API de Reading List. Consulta Ejemplos de extensiones para ver ejemplos completos de extensiones.

Cómo agregar un elemento

Para agregar un elemento a la lista de lectura, usa chrome.readingList.addEntry():

chrome.readingList.addEntry({
  title: "New to the web platform in September | web.dev",
  url: "https://developer.chrome.com/",
  hasBeenRead: false
});

Elementos de visualización

Para mostrar elementos de la lista de lectura, usa el método chrome.readingList.query() para recuperarlos.

const items = await chrome.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

Cómo marcar un elemento como leído

Puedes usar chrome.readingList.updateEntry() para actualizar el título, la URL y el estado de lectura. El siguiente código marca un elemento como leído:

chrome.readingList.updateEntry({
  url: "https://developer.chrome.com/",
  hasBeenRead: true
});

Cómo quitar un elemento

Para quitar un elemento, usa chrome.readingList.removeEntry():

chrome.readingList.removeEntry({
  url: "https://developer.chrome.com/"
});

Muestras de extensiones

Para ver más demostraciones de extensiones de la API de Reading List, consulta el ejemplo de la API de Reading List.

Tipos

AddEntryOptions

Propiedades

  • hasBeenRead

    booleano

    Será true si se leyó la entrada.

  • título

    string

    Es el título de la entrada.

  • url

    string

    Es la URL de la entrada.

QueryInfo

Propiedades

  • hasBeenRead

    booleano opcional

    Indica si se deben buscar elementos leídos (true) o no leídos (false).

  • título

    cadena opcional

    Es el título que se buscará.

  • url

    cadena opcional

    Es una URL para buscar.

ReadingListEntry

Propiedades

  • creationTime

    número

    Es la fecha y hora en que se creó la entrada. Se registra en milisegundos desde el 1 de enero de 1970.

  • hasBeenRead

    booleano

    Será true si se leyó la entrada.

  • lastUpdateTime

    número

    Fecha y hora en la que se actualizó la entrada por última vez. Este valor se expresa en milisegundos desde el 1 de enero de 1970.

  • título

    string

    Es el título de la entrada.

  • url

    string

    Es la URL de la entrada.

RemoveOptions

Propiedades

  • url

    string

    Es la URL que se quitará.

UpdateEntryOptions

Propiedades

  • hasBeenRead

    booleano opcional

    Es el estado de lectura actualizado. Si no se proporciona un valor, se mantiene el estado existente.

  • título

    cadena opcional

    Es el nuevo título. Si no se proporciona un valor, se conservará la tarjeta existente.

  • url

    string

    Es la URL que se actualizará.

Métodos

addEntry()

chrome.readingList.addEntry(
  entry: AddEntryOptions,
): Promise<void>

Agrega una entrada a la lista de lectura si no existe.

Parámetros

  • Es la entrada que se agregará a la lista de lectura.

Muestra

  • Promise<void>

query()

chrome.readingList.query(
  info: QueryInfo,
): Promise<ReadingListEntry[]>

Recupera todas las entradas que coinciden con las propiedades de QueryInfo. Las propiedades que no se proporcionen no se correlacionarán.

Parámetros

  • información

    QueryInfo

    Son las propiedades que se buscarán.

Muestra

removeEntry()

chrome.readingList.removeEntry(
  info: RemoveOptions,
): Promise<void>

Quita una entrada de la lista de lectura si existe.

Parámetros

  • información

    RemoveOptions

    Es la entrada que se quitará de la lista de lectura.

Muestra

  • Promise<void>

updateEntry()

chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
): Promise<void>

Actualiza una entrada de la lista de lectura si existe.

Parámetros

Muestra

  • Promise<void>

Eventos

onEntryAdded

chrome.readingList.onEntryAdded.addListener(
  callback: function,
)

Se activa cuando se agrega un ReadingListEntry a la lista de lectura.

Parámetros

onEntryRemoved

chrome.readingList.onEntryRemoved.addListener(
  callback: function,
)

Se activa cuando se quita un ReadingListEntry de la lista de lectura.

Parámetros

onEntryUpdated

chrome.readingList.onEntryUpdated.addListener(
  callback: function,
)

Se activa cuando se actualiza un ReadingListEntry en la lista de lectura.

Parámetros