Module Reference / @tinystacks/ops-core-widgets / Github
Interface: Github
@tinystacks/ops-core-widgets.Github
Example
Github:
type: Github
displayName: Github Action Workflows
organization: my-org
repository: my-repo
providers:
- $ref: '#/Console/providers/GithubProvider'
Hierarchy
↳ Github
Table of contents
Properties
- actions
- additionalProperties
- childrenIds
- description
- displayName
- displayOptions
- host
- id
- organization
- providerIds
- repository
- type
Properties
actions
• Optional actions: GithubAction[]
Defined in
node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:74
additionalProperties
• Optional additionalProperties: any
Inherited from
Widget.additionalProperties
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:30
childrenIds
• Optional childrenIds: string[]
Inherited from
Widget.childrenIds
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:18
description
• Optional description: string
Inherited from
Widget.description
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:19
displayName
• displayName: string
A human-readable display name, usually used to title a widget
Inherited from
Widget.displayName
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:12
displayOptions
• Optional displayOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
showDescription? |
boolean |
Whether to show the description |
showDisplayName? |
boolean |
Whether to show the display name |
Inherited from
Widget.displayOptions
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:20
host
• Optional host: string
Defined in
node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:71
id
• id: string
Unique Id for this widget.
Inherited from
Widget.id
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:8
organization
• organization: string
Defined in
node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:72
providerIds
• Optional providerIds: string[]
Inherited from
Widget.providerIds
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:17
repository
• repository: string
Defined in
node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:73
type
• type: string
This describes how this widget should be rendered. The "type" should be equivalent to the Object definition's name of the widget you are trying to render.
Inherited from
Widget.type
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:16