@tax-justice-network/fsi-components
v3.0.1
Published
<a href="https://www.npmjs.com/@tax-justice-network/fsi-components" target="_blank"> <img src="https://img.shields.io/npm/v/@tax-justice-network/fsi-components.svg" alt="FSI Components package on npm" /> </a>
Readme
Ranking components for the FSI website
Changelog
See the CHANGELOG.md for a detailed list of changes.
Usage
1. Add configuration just before the closing </head> tag
💡 Replace API TOKEN FOR ACCESSING FSI DATA with your API token.
<script>
window.TJN_API_ROOT = "https://api.data.taxjustice.net/v1";
window.TJN_API_TOKEN = "API TOKEN FOR ACCESSING FSI DATA";
</script>2. Include JS script below the configuration, just before the closing </head> tag
💡 You have to update this code to update to the new version of the components
<script
type="text/javascript"
src="https://cdn.jsdelivr.net/npm/@tax-justice-network/[email protected]/package/components.js"
crossorigin="anonymous"
integrity="sha384-BpsPnkn2SIOxPIPC2if9cOSTPXvhyEVgwomL/XjJPzr2Qg72vwgfIstFFfOVCELf"
async
></script>3. Add the components to your HTML
💡 Use the Custom HTML block in Wordpress
💡 The lang="..." parameter can be one of: en,fr,es,pt,ar
Ranking Table
💡Component uses the latest scoring with the provided methodology_id at load time and shows a selector to switch between other scorings.
<tjn-country-ranking methodology_id="fsi_8.0" detail_url="/country-detail" lang="en"></tjn-country-ranking>Country detail
💡The tjn-country-detail and tjn-country-breakdown components need scoring_id and jurisdiction_id parameters in the URL, but those are automatically provided by the <tjn-country-selector> component.
<tjn-country-selector lang="en"></tjn-country-selector>
<tjn-country-detail lang="en"></tjn-country-detail>
<tjn-country-breakdown lang="en"></tjn-country-breakdown>Indicator detail
💡You must provide indicator variable in URL after the # sign, e.g. https://fsi.taxjustice.net/indicator-detail/#indicator=SI01 otherwise component will be empty.
💡Component uses the latest scoring with the provided methodology_id.
<tjn-indicator-detail methodology_id="fsi_8.0" lang="en"></tjn-indicator-detail>