@aristotle-metadata-enterprises/aristotle_tooltip
Advanced tools
Readme
A highly customisable and easy to use way to insert Aristotle powered definitions to your website!
Install the aristotle-tooltip package:
frankie@aristotle:~$ npm i @aristotle-metadata-enterprises/aristotle_tooltip
In your application, import the aristotle_tooltip module, and the core css:
import aristotleTooltip from '@aristotle-metadata-enterprises/aristotle_tooltip'
import 'aristotle_tooltip/dist/tooltip.css'
This assumes you're using a module bundler like Webpack, Rollup or Parcel.
<script src="https://cdn.jsdelivr.net/npm/@aristotle-metadata-enterprises/aristotle_tooltip@latest/dist/aristotletooltip.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aristotle-metadata-enterprises/aristotle_tooltip@latest/dist/tooltip.css">
Place the script at the very bottom of the <body>. It must be placed before your own scripts, because of how the underlying Tippy.js library adds the tooltips.
To add a tooltip for a piece of content on your webpage:
A <a href="#" data-aristotle-concept-id="498427">person</a> is known by the company they keep
Custom styling for Aristotle links can set by applying CSS rules that target attribute decorators:
a[data-aristotle-concept-id] {
border-bottom: 1px dotted #155799;
}
a[data-aristotle-concept-id]:hover {
text-decoration: none;
border-bottom: 1px solid #155799;
}
let options = {
'url': 'https://registry.aristotlemetadata.com',
'definitionWords': 50,
'longDefinitionWords': 75,
};
aristotleTooltip(options);
| Option | Default | Explanation |
|---|---|---|
url | registry.aristotlemetadata.com | The URL of an Aristotle Metadata Registry |
definitionWords | 50 | The number of words to display in the initial popup |
longDefinitionWords | 75 | The number of words to display when 'see more..' is pressed |
placement | bottom | The positioning of the tooltip |
trigger | mouseenter focus | Events used to trigger the tooltip |
externalLinkVisible | true | Whether to display an external link icon next to the name of the metadata item |
selector | document.body | Element or css selector for creating tooltips under, tooltips not under this element will be ignored |
interactive | true | Whether interactive content such as links should be displayed |
We're an open source project that welcomes any new contributions. To setup a development environment, simply fork the repo, clone it locally, and from within the aristotle-tooltip project, run:
oscar@aristotle:~$ npm install
oscar@aristotle:~$ npm run build:dev
A Promise polyfill is required for IE11 compatibility.aristotle-tooltip has been tested to work with ES6 Promise
<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.js"></script>
FAQs
Aristotle Tooltip: add Aristotle functionality to any website!
We found that @aristotle-metadata-enterprises/aristotle_tooltip demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.