# Ranking components for the FSI website FSI Components package on npm ## Changelog See the [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes. ## Usage ### 1. Add configuration just before the closing `` tag 💡 Replace `API TOKEN FOR ACCESSING FSI DATA` with your API token. ```html ``` | Variable | Description | | ----------------- | -------------------------------------------------------------------------------------------------------- | | `TJN_API_ROOT` | API root URL for the components to load data from.
**Default:** `https://api.data.taxjustice.net/v1` | | `TJN_API_TOKEN` | API token for accessing FSI data. You can obtain an API token by contacting the TJN team. | | `TJN_FSI_EDITION` | Edition of the FSI to load data from. Endpoints are then called as `${edition}_${endpoint}` | ### 2. Include JS script below the configuration, just before the closing `` tag 💡 You have to update this code to update to the new version of the components ```html ``` ### 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. ```html ``` #### 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 `` component. ```html ``` #### 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`. ```html ```