https://github.com/thenextweb/indexdotco-js
Embed Index.co rich data on your site
https://github.com/thenextweb/indexdotco-js
Last synced: 11 months ago
JSON representation
Embed Index.co rich data on your site
- Host: GitHub
- URL: https://github.com/thenextweb/indexdotco-js
- Owner: thenextweb
- Created: 2016-07-26T09:41:46.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-03-14T15:16:27.000Z (over 7 years ago)
- Last Synced: 2024-11-30T11:12:55.982Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 513 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# indexdotco-js
JS for Index.co embeds in external sites
[Download it here](https://github.com/thenextweb/indexdotco-js/releases)
## Usage
Get the last `indexdotco.js` [release](https://github.com/thenextweb/indexdotco-js/releases)
on your site. Then use either of the following:
* Icon with hover functionality.
``
* A single company widget
``
* A single company widget, in dark mode
``
* Embed all companies from a list
``
## Customization
You can use your own site's css to customize the size, colors and fonts of the
cards inside, there's some very basic css bundled directly with this module
but final tweaks are up to you!
## Advanced Usage
### Options
You can add options by creating an `indexDotCoSettings` object on your site
```
window.indexDotCoSettings = {
delay: true
/* won't scan for elements on page load */
disableCss: true,
/* won't append any custom css, you'll have to provide your own
or import template/base.css via other means */
maxLines: 6
/* max number of text lines on cards */
};
```
### Ajax loading
If you are loading new content using ajax, use `IndexDotCo.attach()` to rescan
the DOM at any time and draw any new cards
### Webpack + babel
If you are using webpack and babel you can instead import `indexdotco-js` as a
module on your existing codebase.
(It's even on npm! just do `npm install indexdotco-js`)
This won't create any global objects on `window`, you can instead pass
arguments to the constructor and then use the `IndexDotCo` class,
it exposes the same methods.
```
var IndexDotCoConstructor = require('indexdotco-js');
var IndexDotCo = new IndexDotCoConstructor(settings);
```
## Building the code yourself
Use `gulp` with no arguments to build `dist/indexdotco-dev.js` uncompressed,
along with its sourcemap. Webpack will keep on watching for any changes on the code.
Use `gulp make` to build `dist/indexdotco.js`, `gulp test` to check if
everything went okay
Test your changes opening `test/basic.html` in your browser. Append `#local` to
the url to test changes in `dist/indexdotco-dev.js`
