Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamwork/public-components
Public components to enhance your interaction with Teamwork
https://github.com/teamwork/public-components
Last synced: 3 days ago
JSON representation
Public components to enhance your interaction with Teamwork
- Host: GitHub
- URL: https://github.com/teamwork/public-components
- Owner: Teamwork
- License: mit
- Created: 2020-10-05T12:02:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T10:08:06.000Z (about 1 year ago)
- Last Synced: 2024-04-18T12:58:07.162Z (7 months ago)
- Language: JavaScript
- Size: 534 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# public-components
Public components to enhance your interaction with Teamwork
## Login with Teamwork button
### Usage
*From the CDN*
```html
```
*Using NPM*
First install it
```
npm -i @teamwork/login-button --save
```
Then, in your `main.js` file:
```js
import '@teamwork/login-button';
```
And somewhere in you template:
```html
```
### Parameters
| Name | Default | Description | Allowed Values |
|--------------- |----------- |--------------------------------------------------------- |------------------------------------------------------------------------------ |
| `clientID` | | **Required**. Client ID from the [Developer Portal](https://developer.teamwork.com/guides/how-to-authenticate-via-app-login-flow/) | |
| `redirectURI` | | **Required**. Redirect URI for your Developer Portal app | |
| `state` | | Optional. Value will be passed to your redirect URI as a query parameter | |
| `size` | `medium` | Size of the button | `large` `medium` `small` | |
| `borders` | `default` | Button border style | `default` `rounded` `square` | |
| `color` | `white` | Button color theme | `slate` `white` `indigo` `pink` | |
| `iconOnly` | `false` | Show a compact, icon-only version of the button | Attribute presence indicates `true` | |