Skip to content

Files

Latest commit

9c03f45 · Jul 13, 2020

History

History
This branch is 2457 commits behind gitcoinco/web:master.

js-sdk

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 23, 2018
May 9, 2018
May 9, 2018
May 9, 2018
Oct 27, 2018
May 9, 2018
May 9, 2018
Aug 22, 2018
Jul 13, 2020
May 9, 2018
Jul 13, 2020

Gitcoin SDK

Dynamic Widget

Example

Step 1: Include the JavaScript SDK on your page once, ideally right after the opening body tag.

<div id="gc-root"></div>
<script>(function(d, s, id) {
  var js, gjs = d.getElementsByTagName(s)[0];
  if (d.getElementById(id)) return;
  js = d.createElement(s); js.id = id;
  js.src = "https://unpkg.com/gitcoin-sdk";
  gjs.parentNode.insertBefore(js, gjs);
}(document, 'script', 'gitcoin-jssdk'));</script>

Step 2: Place this code wherever you want the plugin to appear on your page.

<div class="gitcoin-widget"
  data-limit="2"
  data-order-by="-expires_date"
  data-organization="MetaMask"
  data-repository="metamask-extension"
></div>

Autoloading

Importing the SDK into your application will attempt to autoload the widget by searching for '.gitcoin-widget' selectors

import 'gitcoin-sdk';

or

require('gitcoin-sdk');

Programmatically

You can also use the Widget programmatically.

import { Widget } from 'gitcoin-sdk';

or

const { Widget } = require('gitcoin-sdk');

Widget can be instantiated by passing a selector option, or an element reference.

new Widget({
  limit: 10,
  orderBy: '-expires_date',
  organization: 'MetaMask',
  repository: 'metamask-extension',
  selector: '.gitcoin-widget',
});