Source code for dash_mp_components.CrossrefCard
# AUTO GENERATED FILE - DO NOT EDIT
import typing # noqa: F401
from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
from dash.development.base_component import Component, _explicitize_args
try:
from dash.types import NumberType # noqa: F401
except ImportError:
# Backwards compatibility for dash<=4.1.0
if typing.TYPE_CHECKING:
raise
NumberType = typing.Union[ # noqa: F401
typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
]
ComponentSingleType = typing.Union[str, int, float, Component, None]
ComponentType = typing.Union[
ComponentSingleType,
typing.Sequence[ComponentSingleType],
]
[docs]
class CrossrefCard(Component):
"""A CrossrefCard component.
Parses a crossref entry or fetches a reference from the crossref API and renders a BibCard.
Keyword arguments:
- id (string; optional):
The ID used to identify this component in Dash callbacks.
- className (string; optional):
Class name(s) to append to the component's default class.
- crossrefEntry (boolean | number | string | dict | list; optional):
A single bib object in crossref format. If a crossEntry is
supplied, a request will not be made to the crossref API. The
following bib values are parsed from a Crossref API response:
title, authors, year, doi, journal.
- errorMessage (string; optional):
Error message to show inside the card if the crossref request
fails @default 'Could not find reference'.
- identifier (string; optional):
Either a DOI or bibtex string to use to search against the
Crossref /works endpoint. An identifier must be supplied if you
are not supplying the crossrefEntry directly.
- preventOpenAccessFetch (boolean; optional):
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."""
_children_props: typing.List[str] = []
_base_nodes = ['children']
_namespace = 'dash_mp_components'
_type = 'CrossrefCard'
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
className: typing.Optional[str] = None,
crossrefEntry: typing.Optional[typing.Any] = None,
identifier: typing.Optional[str] = None,
errorMessage: typing.Optional[str] = None,
preventOpenAccessFetch: typing.Optional[bool] = None,
**kwargs
):
self._prop_names = ['id', 'className', 'crossrefEntry', 'errorMessage', 'identifier', 'preventOpenAccessFetch']
self._valid_wildcard_attributes = []
self.available_properties = ['id', 'className', 'crossrefEntry', 'errorMessage', 'identifier', 'preventOpenAccessFetch']
self.available_wildcard_properties = []
_explicit_args = kwargs.pop('_explicit_args')
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args}
super(CrossrefCard, self).__init__(**args)
setattr(CrossrefCard, "__init__", _explicitize_args(CrossrefCard.__init__))