Skip to content

Commit 7d3d621

Browse files
committed
Deploying to gh-pages from @ 7a93290 🚀
1 parent 82b3b90 commit 7d3d621

File tree

135 files changed

+37
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+37
-131
lines changed

latest/docs/Table.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

latest/docs/TableContext.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"name":"TableContext","description":"React context created by the `Table` component to hold its data which are\nread by its children. You can access these to make custom Table cells/rows.\n\nIt stores the following parameters:\n- `isStacked`: Whether the `Table` is in `stacked` layout.\n- `hover`: Whether highlight rows on mouse hover\n- `headers`: in `stacked` layout the children of the first row of cells\n (e.g. the titles in a table). This is used in `stacked` layout to display\n the titles inline","category":"utilities/react","relativePath":"packages/ui-table/src/Table/TableContext.ts","extension":".ts","srcPath":"packages/ui-table/src/Table/TableContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-table/src/Table/TableContext.ts","packageName":"@instructure/ui-table","requirePath":"@instructure/ui-table/lib/Table/TableContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-table/src/Table/TableContext.ts').default","esPath":"@instructure/ui-table/es/Table/TableContext","themePath":"packages/ui-table/src/Table/TableContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-table/src/Table/TableContext.ts","id":"TableContext","title":"TableContext"}

latest/docs/accessibility.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"description":"\n## Accessibility\n\nWe aim to make our software accessible to everyone, including those with vision, hearing, cognitive, or motor impairments. Having an accessible design allows people of all abilities to interact with, understand, and navigate our products. This means that components are [Perceivable, Operable, Understandable, and Robust](https://www.w3.org/TR/2016/NOTE-UNDERSTANDING-WCAG20-20161007/intro.html#introduction-fourprincs-head). It’s important for us to design and develop products that support a wide range of needs and experiences.\n\n### Color Contrast\n\nOur [default theme](#canvas) colors meet at least a [3:1](http://www.w3.org/TR/WCAG20-TECHS/G183.html) ratio between foreground and background, and our [high contrast theme](#canvas-high-contrast) colors maintain a minimum [4.5:1](http://www.w3.org/TR/WCAG20-TECHS/G18.html) ratio to ensure we comply with WCAG 2.1 AA contrast requirements. This ensures sufficient color contrast between elements so that users with low vision or color blindness can view and use our components.\n\n### Keyboard Navigation\n\nSome users are unable to use a mouse, and instead navigate through applications using tools such as a keyboard, mouth wand, or eye tracking software. Our components are navigable using these technologies without mouse assistance. Keyboard focus follows the page as an eye would scan it (top to bottom, left to right). We also ensure that focus indication is clear and apparent so users are always aware of where their current keyboard focus is within the page. Our components can be interacted with using [standard keystrokes](https://webaim.org/techniques/keyboard/#testing), so there is no need to learn any new shortcuts.\n\n### Assistive Technologies\n\nOur components are [tested in VoiceOver for Mac, and NVDA/JAWS for Windows](https://www.canvaslms.com/accessibility), which are the highest utilized screenreaders (according to [WebAim’s user survey](https://webaim.org/projects/screenreadersurvey7/)). We utilize many different tools to ensure this compatibility, such as features from the Accessible Rich Internet Applications (WAI-ARIA or ARIA) specification to build functionality that is not available with native HTML, and alternative text for images/icons to ensure all users have the same experience when utilizing our components.\n\n### Web Content Accessibility Guidelines (WCAG)\n\nInstructure UI targets WCAG 2.1 Level A and Level AA success criteria, and seeks to provide a highly usable experience for everyone.\n\nFor more information, see the following resources:\n\n[WCAG 2.1](https://www.w3.org/TR/WCAG21/)\n\n[ARIA 1.1](https://www.w3.org/TR/wai-aria-1.1/)\n\n### Feedback\n\nIf you notice any issues with the accessibility of our components, please reach out to us by creating a [GitHub](https://github.com/instructure/instructure-ui/issues) issue and help us make it better.\n","title":"Accessibility","category":"Getting Started","order":6,"relativePath":"docs/getting-started/accessibility.md","extension":".md","srcPath":"docs/getting-started/accessibility.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/getting-started/accessibility.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/getting-started/accessibility","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/getting-started/accessibility.md').default","esPath":"@instructure/docs/getting-started/accessibility","themePath":"docs/getting-started/accessibility.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/getting-started/accessibility.md","id":"accessibility"}
1+
{"description":"\n## Accessibility\n\nWe aim to make our software accessible to everyone, including those with vision, hearing, cognitive, or motor impairments. Having an accessible design allows people of all abilities to interact with, understand, and navigate our products. This means that components are [Perceivable, Operable, Understandable, and Robust](https://www.w3.org/TR/2016/NOTE-UNDERSTANDING-WCAG20-20161007/intro.html#introduction-fourprincs-head). It’s important for us to design and develop products that support a wide range of needs and experiences.\n\n### Color Contrast\n\nOur [default theme](#canvas) colors meet meets WCAG 2.1 AA rules for color contrast, and our [high contrast theme](#canvas-high-contrast) meets WCAG 2.1 AAA rules for color contrast. This ensures sufficient color contrast between elements so that users with low vision or color blindness can view and use our components.\n\n### Keyboard Navigation\n\nSome users are unable to use a mouse, and instead navigate through applications using tools such as a keyboard, mouth wand, or eye tracking software. Our components are navigable using these technologies without mouse assistance. Keyboard focus follows the page as an eye would scan it (top to bottom, left to right). We also ensure that focus indication is clear and apparent so users are always aware of where their current keyboard focus is within the page. Our components can be interacted with using [standard keystrokes](https://webaim.org/techniques/keyboard/#testing), so there is no need to learn any new shortcuts.\n\n### Assistive Technologies\n\nOur components are [tested in VoiceOver for Mac, and NVDA/JAWS for Windows](https://www.canvaslms.com/accessibility), which are the highest utilized screenreaders (according to [WebAim’s user survey](https://webaim.org/projects/screenreadersurvey7/)). We utilize many different tools to ensure this compatibility, such as features from the Accessible Rich Internet Applications (WAI-ARIA or ARIA) specification to build functionality that is not available with native HTML, and alternative text for images/icons to ensure all users have the same experience when utilizing our components.\n\n### Web Content Accessibility Guidelines (WCAG)\n\nInstructure UI targets WCAG 2.1 Level AA and Level AAA success criteria, and seeks to provide a highly usable experience for everyone.\n\nFor more information, see the following resources:\n\n[WCAG 2.1](https://www.w3.org/TR/WCAG21/)\n\n[ARIA 1.3](https://www.w3.org/TR/wai-aria-1.3/)\n\n### Feedback\n\nIf you notice any issues with the accessibility of our components, please reach out to us by creating a [GitHub](https://github.com/instructure/instructure-ui/issues) issue and help us make it better.\n","title":"Accessibility","category":"Getting Started","order":6,"relativePath":"docs/getting-started/accessibility.md","extension":".md","srcPath":"docs/getting-started/accessibility.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/getting-started/accessibility.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/getting-started/accessibility","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/getting-started/accessibility.md').default","esPath":"@instructure/docs/getting-started/accessibility","themePath":"docs/getting-started/accessibility.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/getting-started/accessibility.md","id":"accessibility"}

latest/docs/alpha.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"name":"alpha","description":"Adjust the alpha transparency of a color","params":[{"name":"color","type":"string","optional":false,"description":""},{"name":"percent","type":"number","optional":false,"description":""}],"returns":{"description":"color as rgb string","type":"string"},"category":"utilities","relativePath":"packages/ui-color-utils/src/alpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/alpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/alpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/alpha.ts').default","esPath":"@instructure/ui-color-utils/es/alpha","themePath":"packages/ui-color-utils/src/alpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","id":"alpha","title":"alpha"}
1+
{"name":"alpha","description":"Adjust the alpha transparency of a color","params":[{"name":"color","type":"string","optional":false,"description":""},{"name":"percent","type":"number","optional":false,"description":""}],"returns":{"description":"color as rgb string","type":"string"},"category":"utilities/Color","relativePath":"packages/ui-color-utils/src/alpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/alpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/alpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/alpha.ts').default","esPath":"@instructure/ui-color-utils/es/alpha","themePath":"packages/ui-color-utils/src/alpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","id":"alpha","title":"alpha"}

latest/docs/babel-plugin-transform-imports.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

latest/docs/browserslist-config-instui.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

latest/docs/camelize.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"name":"camelize","description":"Converts a hyphenated string to camel case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'fooBar'\n - 'bazQux'","params":[{"name":"str","type":"string","optional":false,"description":""}],"returns":{"description":"Returns camel cased string","type":"string"},"category":"utilities","relativePath":"packages/ui-utils/src/camelize.ts","extension":".ts","srcPath":"packages/ui-utils/src/camelize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/camelize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/camelize.ts').default","esPath":"@instructure/ui-utils/es/camelize","themePath":"packages/ui-utils/src/camelize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","id":"camelize","title":"camelize"}
1+
{"name":"camelize","description":"Converts a hyphenated string to camel case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'fooBar'\n - 'bazQux'","params":[{"name":"str","type":"string","optional":false,"description":""}],"returns":{"description":"Returns camel cased string","type":"string"},"category":"utilities/utils","relativePath":"packages/ui-utils/src/camelize.ts","extension":".ts","srcPath":"packages/ui-utils/src/camelize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/camelize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/camelize.ts').default","esPath":"@instructure/ui-utils/es/camelize","themePath":"packages/ui-utils/src/camelize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","id":"camelize","title":"camelize"}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"name":"capitalizeFirstLetter","description":"Capitalize the first letter in a string","params":[{"name":"str","type":"string","optional":true,"description":""}],"returns":{"type":"string"},"category":"utilities","relativePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","extension":".ts","srcPath":"packages/ui-utils/src/capitalizeFirstLetter.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/capitalizeFirstLetter","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/capitalizeFirstLetter.ts').default","esPath":"@instructure/ui-utils/es/capitalizeFirstLetter","themePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","id":"capitalizeFirstLetter","title":"capitalizeFirstLetter"}
1+
{"name":"capitalizeFirstLetter","description":"Capitalize the first letter in a string","params":[{"name":"str","type":"string","optional":true,"description":""}],"returns":{"type":"string"},"category":"utilities/utils","relativePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","extension":".ts","srcPath":"packages/ui-utils/src/capitalizeFirstLetter.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/capitalizeFirstLetter","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/capitalizeFirstLetter.ts').default","esPath":"@instructure/ui-utils/es/capitalizeFirstLetter","themePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","id":"capitalizeFirstLetter","title":"capitalizeFirstLetter"}

0 commit comments

Comments
 (0)