Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: missing api docs #1185

Merged
merged 1 commit into from
Jul 20, 2023
Merged

fix: missing api docs #1185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/angular-workspace/projects/angular/src/directives/proxies-list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// @ts-nocheck

import * as d from './proxies';

Expand Down
8 changes: 4 additions & 4 deletions packages/angular-workspace/projects/angular/src/directives/proxies.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24133,15 +24133,15 @@ export declare interface RuxSegmentedButton extends Components.RuxSegmentedButto


@ProxyCmp({
inputs: ['disabled', 'errorText', 'helpText', 'inputId', 'invalid', 'label', 'labelId', 'multiple', 'name', 'required', 'size', 'value'],
inputs: ['disabled', 'errorText', 'helpText', 'inline', 'inputId', 'invalid', 'label', 'labelId', 'multiple', 'name', 'required', 'size', 'value'],
methods: ['setFocus']
})
@Component({
selector: 'rux-select',
changeDetection: ChangeDetectionStrategy.OnPush,
template: '<ng-content></ng-content>',
// eslint-disable-next-line @angular-eslint/no-inputs-metadata-property
inputs: ['disabled', 'errorText', 'helpText', 'inputId', 'invalid', 'label', 'labelId', 'multiple', 'name', 'required', 'size', 'value'],
inputs: ['disabled', 'errorText', 'helpText', 'inline', 'inputId', 'invalid', 'label', 'labelId', 'multiple', 'name', 'required', 'size', 'value'],
})
export class RuxSelect {
protected el: HTMLElement;
Expand All @@ -24166,14 +24166,14 @@ export declare interface RuxSelect extends Components.RuxSelect {


@ProxyCmp({
inputs: ['axisLabels', 'disabled', 'errorText', 'helpText', 'label', 'max', 'min', 'name', 'step', 'ticksOnly', 'value']
inputs: ['axisLabels', 'disabled', 'errorText', 'helpText', 'label', 'max', 'min', 'minVal', 'name', 'step', 'strict', 'ticksOnly', 'value']
})
@Component({
selector: 'rux-slider',
changeDetection: ChangeDetectionStrategy.OnPush,
template: '<ng-content></ng-content>',
// eslint-disable-next-line @angular-eslint/no-inputs-metadata-property
inputs: ['axisLabels', 'disabled', 'errorText', 'helpText', 'label', 'max', 'min', 'name', 'step', 'ticksOnly', 'value'],
inputs: ['axisLabels', 'disabled', 'errorText', 'helpText', 'label', 'max', 'min', 'minVal', 'name', 'step', 'strict', 'ticksOnly', 'value'],
})
export class RuxSlider {
protected el: HTMLElement;
Expand Down
6 changes: 6 additions & 0 deletions packages/web-components/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,9 @@ export namespace Components {
* Applies a smaller clock style.
*/
"small": boolean;
/**
* Prevents clock from ticking. Use with `date-in` for full control over the displayed time
*/
"static": boolean;
/**
* Accepts the [IANA timezone string format](https://www.iana.org/time-zones) such as `'America/Los_Angeles'` or any single-character designation for a [military timezones](https://en.wikipedia.org/wiki/List_of_military_time_zones) (`'A'` through `'Z'`, excluding `'J'`), both case-insensitive. If no value for timezone is provided, the clock will use `'UTC'`. See [`toLocaleString()` on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString#Parameters) for more details.
Expand Down Expand Up @@ -35684,6 +35687,9 @@ declare namespace LocalJSX {
* Applies a smaller clock style.
*/
"small"?: boolean;
/**
* Prevents clock from ticking. Use with `date-in` for full control over the displayed time
*/
"static"?: boolean;
/**
* Accepts the [IANA timezone string format](https://www.iana.org/time-zones) such as `'America/Los_Angeles'` or any single-character designation for a [military timezones](https://en.wikipedia.org/wiki/List_of_military_time_zones) (`'A'` through `'Z'`, excluding `'J'`), both case-insensitive. If no value for timezone is provided, the clock will use `'UTC'`. See [`toLocaleString()` on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString#Parameters) for more details.
Expand Down
13 changes: 10 additions & 3 deletions packages/web-components/src/components/rux-button-group/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,18 @@ Instead, you should use `flex` or `grid` in combination with our spacing design
| `hAlign` | `h-align` | The horizontal alignment of buttons within the group | `"center" \| "left" \| "right"` | `'left'` |


## Slots

| Slot | Description |
| ------------- | ------------------------------------------------------- |
| `"(default)"` | Two or more RuxButton components to render in the group |


## Shadow Parts

| Part | Description |
| ------------- | ----------- |
| `"container"` | |
| Part | Description |
| ------------- | ------------------------ |
| `"container"` | the components container |


----------------------------------------------
Expand Down
7 changes: 2 additions & 5 deletions packages/web-components/src/components/rux-button-group/rux-button-group.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import { Prop, Component, h } from '@stencil/core'

/**
* @slot (default) - Two or more RuxButton components to render in the group
* @part container - the components container
*/

/**
* @deprecated Button Group is deprecated and will be removed in a next major release.
* Instead, you should use `flex` or `grid` in combination with our spacing design tokens.
* @slot (default) - Two or more RuxButton components to render in the group
* @part container - the components container
*/
@Component({
tag: 'rux-button-group',
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/src/components/rux-clock/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Define AOS and LOS with valid [Unix Time Stamp](http://pubs.opengroup.org/online
| `hideTimezone` | `hide-timezone` | Hides the timezone in the main 24-hour clock. Timezone does not display on AOS/LOS. | `boolean` | `false` |
| `los` | `los` | When supplied with a valid [date string or value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#syntax), displays a timestamp labeled "LOS" next to the standard clock. | `string \| undefined` | `undefined` |
| `small` | `small` | Applies a smaller clock style. | `boolean` | `false` |
| `static` | `static` | | `boolean` | `false` |
| `static` | `static` | Prevents clock from ticking. Use with `date-in` for full control over the displayed time | `boolean` | `false` |
| `timezone` | `timezone` | Accepts the [IANA timezone string format](https://www.iana.org/time-zones) such as `'America/Los_Angeles'` or any single-character designation for a [military timezones](https://en.wikipedia.org/wiki/List_of_military_time_zones) (`'A'` through `'Z'`, excluding `'J'`), both case-insensitive. If no value for timezone is provided, the clock will use `'UTC'`. See [`toLocaleString()` on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleTimeString#Parameters) for more details. | `string` | `'UTC'` |


Expand Down
3 changes: 3 additions & 0 deletions packages/web-components/src/components/rux-clock/rux-clock.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ export class RuxClock {
this.convertedAos = this._formatLosAosDateIn(newValue)
}

/**
* Prevents clock from ticking. Use with `date-in` for full control over the displayed time
*/
@Prop() static = false
/**
* When supplied with a valid [date string or value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#syntax), displays a timestamp labeled "LOS" next to the standard clock.
Expand Down
16 changes: 8 additions & 8 deletions packages/web-components/src/components/rux-global-status-bar/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ There is one unnamed slot in the Global Status Bar. This slot is intended for an

## Shadow Parts

| Part | Description |
| ------------- | -------------------------------------------- |
| `"app-meta"` | The container for the Application's metadata |
| `"app-state"` | The container for the applications state |
| `"center"` | The container for the default slot content |
| `"container"` | The container for global-status-bar |
| `"middle"` | |
| `"username"` | The container for the username |
| Part | Description |
| ------------- | ----------------------------------------------------- |
| `"app-meta"` | The container for the Application's metadata |
| `"app-state"` | The container for the applications state |
| `"center"` | The container for the default slot content |
| `"container"` | The container for global-status-bar |
| `"middle"` | The container for the middle of the global-status-bar |
| `"username"` | The container for the username |


## Dependencies
Expand Down
1 change: 1 addition & 0 deletions packages/web-components/src/components/rux-global-status-bar/rux-global-status-bar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { AppMeta } from './appMeta/appMeta'
* @slot right-side - Used to append optional content
*
* @part app-state - The container for the applications state
* @part middle - The container for the middle of the global-status-bar
* @part container - The container for global-status-bar
* @part username - The container for the username
* @part app-meta - The container for the Application's metadata
Expand Down
1 change: 1 addition & 0 deletions packages/web-components/src/components/rux-select/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Select Menu renders a native `<select>` element and allows native `<option>` and
| `disabled` | `disabled` | Disables the select menu via HTML disabled attribute. Select menu takes on a distinct visual state. Cursor uses the not-allowed system replacement and all keyboard and mouse events are ignored. | `boolean` | `false` |
| `errorText` | `error-text` | The validation error text | `string \| undefined` | `undefined` |
| `helpText` | `help-text` | The help or explanation text | `string \| undefined` | `undefined` |
| `inline` | `inline` | Styles the select menu as a inline, borderless variant. | `boolean \| undefined` | `false` |
| `inputId` | `input-id` | Id for the Select Input | `string \| undefined` | `undefined` |
| `invalid` | `invalid` | Presentational only. Renders the Select Menu as invalid. | `boolean` | `false` |
| `label` | `label` | The select label text. For HTML content, use the `label` slot instead. | `string \| undefined` | `undefined` |
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/rux-slider/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,13 @@ Pass properties via attributes similar to the native [HTML Input Range](https://
| `"tick-container"` | The container of the tick mark and axis-label |


## CSS Custom Properties

| Name | Description |
| ------------------------------------ | ---------------------------------------- |
| `--slider-track-before-thumb-height` | the height of the track before the thumb |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
6 changes: 3 additions & 3 deletions packages/web-components/src/components/rux-status/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

## Shadow Parts

| Part | Description |
| ---------- | ----------- |
| `"status"` | |
| Part | Description |
| ---------- | -------------------------------------- |
| `"status"` | the container of the rux-status symbol |


## Dependencies
Expand Down
7 changes: 3 additions & 4 deletions packages/web-components/src/components/rux-status/rux-status.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@ import { Prop, Host, Component, h, Watch, Element } from '@stencil/core'
import { Status, StatusTypes } from '../../common/commonTypes.module'
// import DarkStatus from './statuses/dark-theme'
import StatusSVG from './statuses/light-theme'
/**
* @part status - the container of the rux-status symbol
*/

@Component({
tag: 'rux-status',
styleUrl: 'rux-status.scss',
shadow: true,
})

/**
* @part status - the container of the rux-status symbol
*/
export class RuxStatus {
/**
* Sets the status symbol, valid options are critical, serious, caution, normal, standby and off
Expand Down
20 changes: 15 additions & 5 deletions packages/web-components/src/components/rux-tree-node/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,23 @@ Type: `Promise<void>`



## Slots

| Slot | Description |
| ------------- | -------------------------------------------- |
| `"(default)"` | The parent node content |
| `"node"` | Renders a child node within the current node |
| `"prefix"` | Renders content before the default slot |
| `"suffix"` | Renders content after the default slot |


## Shadow Parts

| Part | Description |
| ------------- | ----------- |
| `"indicator"` | |
| `"node"` | |
| `"text"` | |
| Part | Description |
| ------------- | -------------------------------------------- |
| `"indicator"` | The opened/closed indicator |
| `"node"` | The individual tree node |
| `"text"` | The area bewteen the prefix and suffix slots |


----------------------------------------------
Expand Down
10 changes: 5 additions & 5 deletions packages/web-components/src/components/rux-tree-node/rux-tree-node.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ import {
import { hasSlot } from '../../utils/utils'

let id = 0
@Component({
tag: 'rux-tree-node',
styleUrl: 'rux-tree-node.scss',
shadow: true,
})

/**
* @slot (default) - The parent node content
Expand All @@ -31,6 +26,11 @@ let id = 0
* @part indicator - The opened/closed indicator
* @part node - The individual tree node
*/
@Component({
tag: 'rux-tree-node',
styleUrl: 'rux-tree-node.scss',
shadow: true,
})
export class RuxTreeNode {
private componentId = `node-${++id}`

Expand Down
Loading