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.

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

add disableFocusLock prop #234

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
1b55d34
Remove unused file
elrumordelaluz Sep 24, 2019
c8c4edb
Improve actionBefore behaviour
elrumordelaluz Sep 24, 2019
a048f5e
Update dependencies
elrumordelaluz Sep 26, 2019
fbc4a8a
Update dependencies
elrumordelaluz Oct 2, 2019
5c2b71f
Update dependencies
elrumordelaluz Oct 3, 2019
48bc0e4
Remove lodash.pick dependency
elrumordelaluz Oct 3, 2019
f58c40b
Update dependencies
elrumordelaluz Oct 10, 2019
4cc6bec
Update dependencies
elrumordelaluz Oct 11, 2019
749d50b
Added option to add aria-label attribute to each step's navigation dot
nelsonwong1012 Oct 22, 2019
0b6b9a8
Update dependencies
elrumordelaluz Oct 22, 2019
67a968c
Update dependencies
elrumordelaluz Oct 22, 2019
7c34ab2
Round translate values to avoid text blurring in browser
elrumordelaluz Nov 15, 2019
43061be
checkFnAndRun is not in scope in useEffect so replace with manual che…
Oct 31, 2019
088f171
checkFnAndRun is out of scope after building, fallign back to manual …
Oct 31, 2019
9c774db
ensure tour step dialog starts centered but does not attempt to cente…
Oct 31, 2019
c6ab7f5
ensure tour can be started at specific step.
Oct 31, 2019
8beb0ab
added notes for updates from fork
Nov 6, 2019
6849116
ensure mask click event is IE11 compatible.
tarqu1n Nov 22, 2019
b93a1b5
reverse custom readme changes for PR
tarqu1n Nov 22, 2019
bd164ef
ensure default for startStep prop is set.
tarqu1n Nov 22, 2019
c065f08
update docs to show default value for start at prop.
tarqu1n Nov 22, 2019
72504ed
Merge branch 'tarqu1n-temp-bug-fixes'
elrumordelaluz Nov 22, 2019
5dc6dc9
Update readme
elrumordelaluz Nov 27, 2019
f37fffc
Fix demo (CustomHelper) arrow event
elrumordelaluz Dec 5, 2019
36ffe10
Fix demo
elrumordelaluz Dec 5, 2019
951318f
Update dependencies
elrumordelaluz Dec 6, 2019
7f595bf
ensure inital open triggers the opening steps actionBefore function
Dec 9, 2019
cbfe3d8
Merge pull request #216 from tarqu1n/bugfix-actionbefore-first-step
elrumordelaluz Jan 2, 2020
3222544
yarn upgrade
elrumordelaluz Jan 7, 2020
2a062a7
Merge branch 'nav-dot-aria-labels' of https://github.com/nelsonwong10…
elrumordelaluz Jan 9, 2020
32a774f
Merge branch 'nelsonwong1012-nav-dot-aria-labels'
elrumordelaluz Jan 9, 2020
facbe7c
Add role="dialog" for accessibility
nelsonwong1012 Jan 14, 2020
5c40031
Merge pull request #220 from nelsonwong1012/aria_role_dialog
elrumordelaluz Jan 14, 2020
3c45702
Add prop for close button aria-label
nelsonwong1012 Jan 15, 2020
0c79d70
Render close button if showCloseButton is true
nelsonwong1012 Jan 15, 2020
50a4e05
defaultProp for closeButtonAriaLabel
nelsonwong1012 Jan 17, 2020
12211bd
Merge pull request #222 from nelsonwong1012/close_button_aria_label
elrumordelaluz Jan 20, 2020
9ee4f0e
Prop to add aria-labelledby attribute for accessibility
nelsonwong1012 Jan 15, 2020
1c3a518
Merge pull request #223 from nelsonwong1012/aria_labelledby
elrumordelaluz Jan 21, 2020
2c51677
showNavigationScreenReaders prop to control showing/hiding the naviga…
nelsonwong1012 Jan 21, 2020
ad18a34
Combined a11y related props into a single prop
nelsonwong1012 Jan 23, 2020
3e37d1f
Merge pull request #228 from nelsonwong1012/nav-dots-aria-hidden-comb…
elrumordelaluz Jan 27, 2020
1324a4a
add props disableFocusLock
Feb 12, 2020
465e07e
update readme file
Feb 12, 2020
111ee69
Merge pull request #1 from bellsml/feature/flag-to-disable-focuslock
bellsml Feb 12, 2020
0456f82
remove focus() on helper
Feb 12, 2020
0cefa54
Merge branch 'master' into feature/flag-to-disable-focuslock
Feb 12, 2020
6c1eff1
Add class on Close button Component
elrumordelaluz Apr 7, 2020
3649358
Merge branch 'master' into feature/flag-to-disable-focuslock
bellsml Apr 7, 2020
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
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
</a>
</p>

<br />

> ⚠️ The `master` branch is currently in _development_. Please use the [v1 branch](https://github.com/elrumordelaluz/reactour/tree/v1) to follow the current versions published.

<br />

## Install

```zsh
Expand Down Expand Up @@ -70,6 +76,22 @@ Type: `string`

Default: `#007aff`

#### accessibilityOptions

> Configure accessibility related accessibility options

Type: `object`

Default:
```js
// attribute to associate the dialog with a title for screen readers
ariaLabelledBy: null,
// aria-label attribute for the close button
closeButtonAriaLabel: 'Close',
// Show/Hide Navigation Dots for screen reader software
showNavigationScreenReaders: true,
```

#### badgeContent

> Customize _Badge_ content using `current` and `total` steps values
Expand Down Expand Up @@ -310,9 +332,11 @@ Default: `true`

Type: `number`

Default: `0`

#### steps

> Array of elements to highligt with special info and props
> Array of elements to highlight with special info and props

Type: `shape`

Expand All @@ -335,6 +359,7 @@ steps: PropTypes.arrayOf(PropTypes.shape({
'action': PropTypes.func,
'style': PropTypes.object,
'stepInteraction': PropTypes.bool,
'navDotAriaLabel': PropTypes.string,
})),
```

Expand Down Expand Up @@ -366,6 +391,8 @@ const steps = [
// Could be enabled passing `true`
// when `disableInteraction` prop is present in Tour
stepInteraction: false,
// Text read to screen reader software for this step's navigation dot
navDotAriaLabel: 'Go to step 4',
},
// ...
]
Expand All @@ -385,6 +412,14 @@ Type: `number`

Default: `1`

#### disableFocusLock

> Disable FocusLock component.

Type: `bool`

Default: `false`

## FAQ

<p>
Expand Down
29 changes: 11 additions & 18 deletions docs/bundle.js

Large diffs are not rendered by default.

47 changes: 23 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,51 +42,50 @@
},
"homepage": "https://github.com/elrumordelaluz/reactour#readme",
"devDependencies": {
"@babel/cli": "7.6.0",
"@babel/core": "7.6.0",
"@babel/plugin-proposal-class-properties": "7.5.5",
"@babel/plugin-syntax-dynamic-import": "7.2.0",
"@babel/polyfill": "7.6.0",
"@babel/preset-env": "7.6.0",
"@babel/preset-react": "7.0.0",
"@babel/cli": "7.7.5",
"@babel/core": "7.7.5",
"@babel/plugin-proposal-class-properties": "7.7.4",
"@babel/plugin-syntax-dynamic-import": "7.7.4",
"@babel/polyfill": "7.7.0",
"@babel/preset-env": "7.7.5",
"@babel/preset-react": "7.7.4",
"babel-eslint": "10.0.3",
"babel-loader": "8.0.6",
"body-scroll-lock": "2.6.4",
"css-loader": "3.2.0",
"eslint": "6.4.0",
"eslint-config-prettier": "6.3.0",
"css-loader": "3.2.1",
"eslint": "6.7.2",
"eslint-config-prettier": "6.7.0",
"eslint-plugin-prettier": "3.1.1",
"html-loader": "0.5.5",
"html-webpack-plugin": "3.2.0",
"prettier": "1.18.2",
"react": "16.9.0",
"react-dom": "16.9.0",
"prettier": "1.19.1",
"react": "16.12.0",
"react-dom": "16.12.0",
"reshake": "1.2.1",
"rimraf": "3.0.0",
"rollup": "1.21.4",
"rollup": "1.27.8",
"rollup-plugin-babel": "4.3.3",
"rollup-plugin-filesize": "6.1.1",
"rollup-plugin-filesize": "6.2.1",
"rollup-plugin-node-resolve": "5.2.0",
"style-loader": "1.0.0",
"styled-components": "4.4.0",
"webpack": "4.40.2",
"webpack-cli": "3.3.9",
"webpack-dev-server": "3.8.1"
"style-loader": "1.0.1",
"styled-components": "4.4.1",
"webpack": "4.41.2",
"webpack-cli": "3.3.10",
"webpack-dev-server": "3.9.0"
},
"peerDependencies": {
"react": "^16.3.0",
"react-dom": "^16.3.0",
"styled-components": "^4.0.0"
},
"dependencies": {
"@rooks/use-mutation-observer": "3.3.0",
"@rooks/use-mutation-observer": "3.4.2",
"classnames": "2.2.6",
"focus-outline-manager": "^1.0.2",
"lodash.debounce": "4.0.8",
"lodash.pick": "4.4.0",
"prop-types": "15.7.2",
"react-focus-lock": "2.1.0",
"scroll-smooth": "1.0.1",
"react-focus-lock": "2.2.1",
"scroll-smooth": "1.1.0",
"scrollparent": "2.0.1"
}
}
Loading