Skip to content

Commit

Permalink
docs: update docs for latest changes (#24)
Browse files Browse the repository at this point in the history
Co-authored-by: Abdallah A. M. Alhalees <[email protected]>
  • Loading branch information
abdhalees and Abdallah A. M. Alhalees authored Jan 19, 2022
1 parent cd74ce6 commit 5e2ec60
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 5 deletions.
5 changes: 2 additions & 3 deletions components/app-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,8 +310,7 @@ Required: No
### breadcrumbs
> Breadcrumbs should be defined within this slot in order to benefit from the
> responsive breadcrumb pattern.
> Use this slot to add the [breadcrumb group component](breadcrumb-group.md) to the app layout.
Expand Down Expand Up @@ -348,7 +347,7 @@ Required: No
### splitPanel
> Split panel.
> Use this slot to add the [split panel component](split-panel.md) to the app layout.
Expand Down
22 changes: 22 additions & 0 deletions components/date-range-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,24 @@ Type: String
Required: No


### dateOnly

> Hides time inputs and changes the input format to date-only, e.g. 2021-04-06.
> Do not use `dateOnly` flag conditionally. The component does not trigger the value update
> when the flag changes which means the value format can become inconsistent.
>
> Default: false.
>
Type: Boolean

Default: `false`

Valid values: `true | false`

Required: No


### disabled

> Specifies that the component is disabled, preventing the user from
Expand Down Expand Up @@ -256,6 +274,8 @@ Required: No
> Specifies the format of the time input for absolute ranges.
> Use to restrict the granularity of time that the user can enter.
>
> Has no effect when `dateOnly` is true.
>
Type: String

Expand All @@ -270,6 +290,8 @@ Required: No

> The time offset from UTC in minutes that should be used to
> display and produce values.
> Has no effect when `dateOnly` is true.
>
> Default: the user's current time offset as provided by the browser.
>
Expand Down
7 changes: 7 additions & 0 deletions components/form.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ Required: No



### secondaryActions

> Specifies left-aligned secondary actions for the form. Use a button dropdown if multiple actions are required.






Expand Down
2 changes: 2 additions & 0 deletions components/property-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ Cancelable: No

> Use this event to asynchronously load filteringOptions, component currently needs. The detail object contains following properties:
> * `filteringProperty` - The property for which you need to fetch the options.
> * `filteringOperator` - The operator for which you need to fetch the options.
> * `filteringText` - The value that you need to use to fetch options.
> * `firstPage` - Indicates that you should fetch the first page of options for a `filteringProperty` that match the `filteringText`.
> * `samePage` - Indicates that you should fetch the same page that you have previously fetched (for example, when the user clicks on the recovery button).
Expand All @@ -360,6 +361,7 @@ Cancelable: No
Detail type:
```
PropertyFilterProps.LoadItemsDetail {
filteringOperator?: PropertyFilterProps.ComparisonOperator
filteringProperty?: PropertyFilterProps.FilteringProperty
filteringText: string
firstPage: boolean
Expand Down
43 changes: 41 additions & 2 deletions components/wizard.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,27 @@ Type: Number
Required: No


### allowSkipTo

> When set to `false`, the *skip-to* button is never shown.
> When set to `true`, the *skip-to* button may appear to offer faster navigation for the user.
> The *skip-to* button only allows to skip optional steps. It is shown when there is one or more optional
> steps ahead having no required steps in-between.
>
> Note: the *skip-to* button requires the function i18nStrings.skipToButtonLabel to be defined.
>
> Defaults to `false`.
>
Type: Boolean

Default: `false`

Valid values: `true | false`

Required: No


### className

> Adds the specified classes to the root element of the component.
Expand All @@ -43,6 +64,8 @@ Required: No
> and returns a string responsible for the navigation summary on smaller screens. For example, "Step 1 of 3". The parameters are as follows:
> - `stepNumber` (number) - The step number that the user is currently on.
> - `stepsCount` (number) - The total number of steps in the wizard.
> - `skipToButtonLabel`: ((targetStep: WizardProps.Step, targetStepNumber: number) => string) - An optional function that accepts the target step object
> and the target step number (1-based indexing), and returns a string to be used as the *skip-to* button label. For example, "Skip to Step 2" or "Skip to end".
> - `cancelButton` (string) - The text of the button that enables the user to exit the flow.
> - `previousButton` (string) - The text of the button that enables the user to return to the previous step.
> - `nextButton` (string) - The text of the button that enables the user to move to the next step.
Expand All @@ -62,6 +85,10 @@ WizardProps.I18nStrings {
stepNumber: number,
stepsCount: number
) => string
skipToButtonLabel?: (
targetStep: WizardProps.Step,
targetStepNumber: number
) => string
stepNumberLabel: (stepNumber: number) => string
}
```
Expand Down Expand Up @@ -116,6 +143,18 @@ Required: Yes



## Slots



### secondaryActions

> Specifies left-aligned secondary actions for the wizard. Use a button dropdown if multiple actions are required.






## Events
Expand All @@ -137,8 +176,8 @@ Cancelable: No
> The event `detail` includes the following:
> - `requestedStepIndex` - The index of the requested step.
> - `reason` - The user action that triggered the navigation event. It can be `next` (when the user clicks the *next* button),
> `previous` (when the user clicks the *previous* button), or `step` (an enabled step link in the navigation pane).
>
> `previous` (when the user clicks the *previous* button), `step` (an enabled step link in the navigation pane),
> or `skip` (when navigated using navigation pane or the *skip-to* button to the previously unvisited step).
>
Detail type:
Expand Down

0 comments on commit 5e2ec60

Please sign in to comment.