Skip to content

Commit

Permalink
Merge pull request #8286 from infor-design/8217-readme
Browse files Browse the repository at this point in the history
8217 - Removed broken links in readme files
  • Loading branch information
ericangeles committed Jan 3, 2024
2 parents 238660c + f58e676 commit 9e9ae4b
Show file tree
Hide file tree
Showing 122 changed files with 84 additions and 406 deletions.
4 changes: 0 additions & 4 deletions src/behaviors/initialize/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@ $(function() {

```

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Code Tips

TODO
2 changes: 0 additions & 2 deletions src/components/about/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ Setting the id/automation id with a string value:

If you set the attributes on the about dialog, you will get an ID added to the root of the dialog. Also the close button will get an id with `-btn-close` appended after the id provided.

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Esc</kbd>: If pressed while open will close the about component and return focus to the triggering element
Expand Down
2 changes: 0 additions & 2 deletions src/components/accordion/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,6 @@ You can add custom id's/automation id's to various parts of the accordion. If yo
</div>
```

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Tab</kbd> - When focus is on an accordion header a <kbd>Tab</kbd> keystroke will move focus in the following manner:
Expand Down
6 changes: 1 addition & 5 deletions src/components/alerts/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,13 @@ Alerts are just specially classed icons. You can added alert icons by adding an

```

Also see [Badges](./badges) for more options.
Also see [Badges](../badges/readme.md) for more options.

## Accessibility

- The traffic light colors are accessibility violations for contrast, however, the high contrast theme provides an alternative that passes. In addition, in context text should be used as color alone cannot provide the meaning.
- An audible span (`class="audible"`) should always be included for accessibility, it should describe the alert status and/or count value in a meaningful way to a non-visual user.

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

Alert icons and Badges do not have tab stops or keyboard interaction on their own. However, they may be placed in a grid cell or other object that has tab focus.
Expand Down
8 changes: 3 additions & 5 deletions src/components/applicationmenu/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,14 +356,12 @@ The menu should respond responsively as follows:
When setting up the application menu for automated testing, ensure that the inner accordion component's links and expander buttons are labelled with id's and automation id's per the [Accordion component's testability guidelines](https://design.infor.com/code/ids-enterprise/latest/accordion#testability). The same rules apply for Role Switcher accordions.
For Application Menus that contain a Searchfield, defer to the [Searchfield component's testability guidelines](https://design.infor.com/code/ids-enterprise/latest/searchfield#testability) for the required elements inside the Searchfield wrapper.
For Application Menus that contain a Searchfield, defer to the [Searchfield component's testability guidelines](https://design.infor.com/components/components/search-field/#testability) for the required elements inside the Searchfield wrapper.
For Application Menus that contain user information, personalized role switching, etc., ensure the following:
- All Buttons follow the [Button component's testability guidelines](https://design.infor.com/code/ids-enterprise/latest/button#testability).
- All Toolbars are implemented using the Flex Toolbar component, and follow the [Flex Toolbar component's testability guidelines](https://design.infor.com/code/ids-enterprise/latest/toolbar-flex#testability).
In general, please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.
- All Toolbars are implemented using the Flex Toolbar component, and follow the [Flex Toolbar component's testability guidelines](https://design.infor.com/components/components/toolbar-flex/#testability).
## Keyboard Shortcuts
Expand All @@ -373,7 +371,7 @@ In IDS Enterprise Controls, the following keyboard shortcuts are implemented in
- When pressing <kbd>Escape</kbd> while the Application Menu is opened, the Application Menu will close and (if applicable) the Trigger Button that originally caused the Application Menu to open will be re-focused.
- Pressing <kbd>F10</kbd> will toggle the menu open or closed, depending on the current state.
In all other cases, the Application Menu uses a IDS Enterprise [Accordion Control](./accordion) internally, and will utilize its keyboard shortcuts when focus lies inside of the menu.
In all other cases, the Application Menu uses a IDS Enterprise [Accordion Control](../accordion/readme.md) internally, and will utilize its keyboard shortcuts when focus lies inside of the menu.
## States and Variations
Expand Down
2 changes: 0 additions & 2 deletions src/components/area/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to the area with `-area` appended, line with `-line` appended and dot with `-dot` appended. In addition the related legend item will get the same id with `-legend` appended after it.

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
4 changes: 0 additions & 4 deletions src/components/arrange/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,6 @@ element.arrange({

- Not implemented. This is not the most accessible functionality. Ideally you would provide a alternate method for doing the action. For example for the grid we would add an "order" column where the user can edit the order by typing not just dragging.

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- Not implemented.
2 changes: 0 additions & 2 deletions src/components/autocomplete/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,3 @@ Setting the id/automation id with a string value:
```

If setting the id/automation id with a function, the id will be a running total of open autocomplete.

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.
4 changes: 0 additions & 4 deletions src/components/badges/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,3 @@ A badge is a CSS only component that uses a `<span>` with the class `badge`. In
## Keyboard Shortcuts

Badges do not have tab stops and have no keyboard interaction on their own, but they may be placed in a grid cell or object that has tab focus.

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.
2 changes: 0 additions & 2 deletions src/components/bar-grouped/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended. In addition the related legend item will get the first group attributes id with `-legend` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/bar-stacked/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended. In addition the related legend item will get the same id with `-legend` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/bar/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/blockgrid/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,3 @@ Setting the id/automation id with a string value or function. The function will
```

Providing the data this will add an ID added to each checkbox with `-blockgrid-checkbox{index}` and checkbox-label with `-blockgrid-checkbox-label{index}` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.
8 changes: 3 additions & 5 deletions src/components/breadcrumb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ This is an example showing a breadcrumb component with four items. The current i

## Breadcrumb Positioning and Variations

The above example just shows an in-page breadcrumb. But usually the breadcrumb would be the top level element in the page. In some cases it is actually in or just below the header. These examples are shown in the [headers section](./demo/components/header/).
The above example just shows an in-page breadcrumb. But usually the breadcrumb would be the top level element in the page. In some cases it is actually in or just below the header. These examples are shown in the [headers section](https://latest-enterprise.demo.design.infor.com/components/header/).

Examples:

- [In Header](./demo/components/header/example-breadcrumbs) this variation is used when the breadcrumb acts as the sole top level navigation.
- [Below Header](./demo/components/header/example-breadcrumbs-alternate) this variation is used when the breadcrumb acts as a secondary top level navigation. For example if its part of the page pattern.
- [In Header](https://latest-enterprise.demo.design.infor.com/components/header/example-breadcrumbs.html) this variation is used when the breadcrumb acts as the sole top level navigation.
- [Below Header](https://latest-enterprise.demo.design.infor.com/components/header/example-breadcrumbs-alternate.html) this variation is used when the breadcrumb acts as a secondary top level navigation. For example if its part of the page pattern.

## Accessibility

Expand Down Expand Up @@ -81,8 +81,6 @@ $('#my-breadcrumb').breadcrumb({
});
```

Please refer to the [Application Testability Checklist](/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Tab</kbd> moves focus to the link. A second <kbd>tab</kbd> moves focus to the next focusable item.
Expand Down
4 changes: 0 additions & 4 deletions src/components/breakpoints/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,3 @@ $('body').on('breakpoint-change', function(e, breakpointState) {
});

```

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.
2 changes: 0 additions & 2 deletions src/components/bubble/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to the line with `-line` appended and dot with `-dot` appended. In addition the related legend item will get the same id with `-legend` appended after it.

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/bullet/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,6 @@ var dataGroupedBullet = [{

Providing the data this will add an ID added to each range with `-range{index}`, measure with `-measure{index}`, difference with `-difference`, title with `-title`, subtitle with `-subtitle`, marker with `-marker` and if more then one marker `-marker{index}` appended. In addition if data grouped the related items will get the same id with `-group{index}` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

Not Applicable
Expand Down
2 changes: 0 additions & 2 deletions src/components/busyindicator/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,6 @@ Setting the id/automation id with a string value:

Providing the data, this will add an ID added to each busyindicator overlay with `-overlay`, active busyindicator with `-busyindicator`, busyindicator text with `-text` and to the root busyindicator element appended.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Responsive Guidelines

Busy Indicators that block UI will usually be placed at a "container" or "form" level, and will cover the container or form elements with an overlay. The overlay should stretch to cover the width and height of the container or form.
6 changes: 2 additions & 4 deletions src/components/button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can also use the button component to make a toggle button. Here is an exampl
</button>
```

If you need a menu button, note that it is comprised of the [popupmenu](./popupmenu) and the button component.
If you need a menu button, note that it is comprised of the [popupmenu](../popupmenu/readme.md) and the button component.

Once the proper markup is in place calling `$(elem).button()` will correctly initialize a menu button. If the arrow icon is missing in the markup it will be added. For example:

Expand Down Expand Up @@ -119,12 +119,10 @@ $('#my-button').button({
})
```

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Spacebar</kbd> or <kbd>Enter</kbd> keys execute the action for that button. If the button activation closes the containing entity or launches another entity, then focus moves to the newly-opened entity. If the button activation does not close or dismiss the containing entity, then focus remains on the button. An example might be an "Apply" or "Recalculate" button.
- <kbd>Enter</kbd> If the button is a menu button the enter key will toggle the menu. Use the arrow keys and enter to select in the menu. See [popupmenu]( ./popupmenu) for details on using the keyboard in the the open menu.
- <kbd>Enter</kbd> If the button is a menu button the enter key will toggle the menu. Use the arrow keys and enter to select in the menu. See [popupmenu](../popupmenu/readme.md) for details on using the keyboard in the the open menu.

## Responsive Guidelines

Expand Down
2 changes: 0 additions & 2 deletions src/components/calendar/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,6 @@ Providing the data this will add an ID to the top calendar div. In addition the
- Week/Day Page View Changer Dropdown day value - gets `week-view-changer-month-day` appended
- Week/Day Page View Changer Dropdown month value - gets `week-view-changer-month-month` appended

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Upgrading from 3.X

- This is a new component for 4.x
4 changes: 0 additions & 4 deletions src/components/cards/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,6 @@ You can add a search field that operates search typeahead on a list. See the exa
</div>
```

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- The header contains a toolbar. Arrow keys should be used between buttons on the toolbar.
Expand Down
6 changes: 1 addition & 5 deletions src/components/charts/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ All of the charts are documented separately by type. See the respective pages fo
1. Line [View Example]( ../line)
1. Positive Negative [View Example]( ../positive-negative)
1. Sparkline [View Example]( ../sparkline)
1. Step Chart [View Example]( ../step-chart)
1. Step Chart [View Example]( ../stepchart)
1. Targeted Achievement [View Example]( ../targeted-achievement)
1. Timeline [View Example]( ../timeline)

Expand All @@ -42,10 +42,6 @@ We still have some work to do to make charts accessible. Some todo's:
- When keying in to the legend elements it should read the data
- Have a table option to display the data in optional data form.

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Tab</kbd> Tab throughout the tabbable elements in the chart.
Expand Down
4 changes: 0 additions & 4 deletions src/components/checkboxes/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,6 @@ The checkbox has now a hitbox style. With this feature, the checkbox has more ro

- Make sure you have matching `for` and `id` values to associate the label with the appropriate form control. Make sure `id`s are unique on each page and only one label can be associated to each unique form element

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- For a two-State checkbox:
Expand Down
2 changes: 0 additions & 2 deletions src/components/circlepager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ Setting the id/automation id with a string value:

These attributes will be attached to the circlepager component root and in control buttons. The control buttons will add `-control` text and the index to get it's unique value. e.g. `automation-id-circlepager-1-control-1`.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Keyboard Shortcuts

- <kbd>Tab</kbd> to move through the pages
Expand Down
2 changes: 0 additions & 2 deletions src/components/colorpicker/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ For the colorpicker if you set the attributes on the input element with the `id`
- Each color in the picker will get `colorNN` for example `azure80`
- The clear button in the picker in the picker will get `clear` appended

Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.

## Responsive Guidelines

- Follows form guidelines or has specific sizes that you can specify
Expand Down
4 changes: 0 additions & 4 deletions src/components/colors/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,3 @@ Background colors can also be set by using the color palette name and appending
## Accessibility

- Do not use color alone to indicate state. If you use a color then also use an icon or text to explain the meaning in case someone is color blind and unable to discern the meaning of the status based on the color.

## Testability

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for further details.
2 changes: 0 additions & 2 deletions src/components/column-grouped/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended. In addition the related legend item will get the first group attributes id with `-legend` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd>You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/column-stacked/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended. In addition the related legend item will get the same id with `-legend` appended after it.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
2 changes: 0 additions & 2 deletions src/components/column/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,6 @@ Setting the id/automation id with a string value or function. The function will

Providing the data this will add an ID added to each bar with `-bar` appended.

- Please refer to the [Application Testability Checklist](https://design.infor.com/resources/application-testability-checklist) for general information.

## Keyboard Shortcuts

- <kbd>Tab</kbd> You can tab into the chart area and through the legend values as each has a focus state.
Expand Down
Loading

0 comments on commit 9e9ae4b

Please sign in to comment.