Package Exports
- jira-web-components
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jira-web-components) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Jira web component library
Web component library for JIRA.
Currently under development. Please keep in mind that it will change later.
Teaser
Get started
Install package...
npm install jira-web-components --save
Or use it from CDN...
<script src="https://unpkg.com/jira-web-components@0.3.0/public/bundle.js"></script>
In order to be able to communicate with JIRA you need a CORS proxy server. Please go to cors-anywhere for more information.
Example which can be hosted on heroku:
// server.js
const host = process.env.HOST || '127.0.0.1';
const port = process.env.PORT || 4444;
const originBlacklist = parseEnvList(process.env.CORSANYWHERE_BLACKLIST);
const originWhitelist = parseEnvList(process.env.CORSANYWHERE_WHITELIST);
function parseEnvList(env) {
if (!env) {
return [];
}
return env.split(',');
}
const corsAnywhere = require('cors-anywhere');
corsAnywhere.createServer({
originBlacklist,
originWhitelist,
removeHeaders: [
'cookie',
'cookie2',
// Strip Heroku-specific headers
'x-heroku-queue-wait-time',
'x-heroku-queue-depth',
'x-heroku-dynos-in-use',
'x-request-start',
],
redirectSameOrigin: true,
httpProxyOptions: {
xfwd: false,
},
}).listen(port, host, function() {
console.log('Running CORS proxy on ' + host + ':' + port);
});
Usage
Config. You have to have it somewhere on the top of the HTML code.
You also have to specify your CORS proxy server URL by setting the cors
param.
<jira-global-config cors="http://localhost:4444"></jira-global-config>
Authentication form.
<jira-auth-form></jira-auth-form>
Auth user card.
<jira-auth-user-card></jira-auth-user-card>
Inline issue ticket.
<jira-issue key="EX-123"></jira-issue>
Replaces the [JIRA:EX-123]
issue ticket codes with <jira-issue>
components.
<jira-text-wrapper>
<p>Lorem ipsum [JIRA:EX-123] dolor sit [JIRA:EX-456] amet.</p>
Lorem ipsum [JIRA:EX-123] dolor sit [JIRA:EX-456] amet.
<p>Lorem ipsum [JIRA:EX-123] dolor sit [JIRA:EX-456] amet.</p>
</jira-text-wrapper>
Made with Love and svelte