% Auto-generated: do not edit by hand
\name{bibFilter}

\alias{bibFilter}

\title{BibFilter component}

\description{
Component for rendering and filtering a list of citations in bibjson or crossref format Expects bibjson in the format output by the bibtexparser library (https://bibtexparser.readthedocs.io/en/v1.1.0/tutorial.html#) Expects crossref in the format returned by the Crossref API
}

\usage{
bibFilter(id=NULL, ascending=NULL, bibEntries=NULL, className=NULL,
format=NULL, preventOpenAccessFetch=NULL,
resultClassName=NULL, sortField=NULL)
}

\arguments{
\item{id}{Character. The ID used to identify this component in Dash callbacks}

\item{ascending}{Logical. Set to true to have the initial sorting direction be ascending
@default false}

\item{bibEntries}{Unnamed list. List of bib objects in bibjson or crossref format
Only the following bib properties are used by this component:
 - title
 - author (as a list or string)
 - year
 - doi
 - journal
If any of those properties are missing, that property will be omitted from the bibjson result card.
Any extra properties are simply ignored.}

\item{className}{Character. Class name(s) to append to the component's default class (mpc-bib-filter)}

\item{format}{A value equal to: 'bibjson', 'crossref'. Format of the bibliographoc objects supplied in bibEntries
@default 'bibjson'}

\item{preventOpenAccessFetch}{Logical. Set to true to prevent dynamically fetching a link to a free PDF of
each reference (using the "doi" field for individual bib entry).
NOTE: the open access URL can also be included in a bib entry
in the "openAccessUrl" property. If set, the URL will not be fetched.
@default false}

\item{resultClassName}{Character. Class name(s) to append to individual result cards' default class (mpc-bib-card)}

\item{sortField}{A value equal to: 'year', 'author', 'title'. Name of property to initially sort entries by
@default 'year'}
}

\value{named list of JSON elements corresponding to React.js properties and their values}