Add screenRecordingPermission option
#96
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
See the feedback in #67. There should be an option for each check. |
index.d.ts
Outdated
|
|
||
| Setting this to true will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property will always be set to an empty string. | ||
| */ | ||
| disableScreenRecordingPermission: boolean; |
There was a problem hiding this comment.
Suggested change
| disableScreenRecordingPermission: boolean; | |
| screenRecordingPermission: boolean; |
index.d.ts
Outdated
| /** | ||
| Disable the screen recording permission check (macOS) | ||
|
|
||
| Setting this to true will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property will always be set to an empty string. |
There was a problem hiding this comment.
Should mention the default value with @default.
https://github.com/sindresorhus/typescript-definition-style-guide
readme.md
Outdated
|
|
||
| ## Options | ||
|
|
||
| - `disableScreenRecordingPermission` *(boolean)* - Disable the screen recording permission check (macOS). Setting this to true will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property will always be set to an empty string. |
There was a problem hiding this comment.
Should use formatting like https://github.com/sindresorhus/boxen#options
readme.md
Outdated
| @@ -45,13 +45,17 @@ const activeWin = require('active-win'); | |||
|
|
|||
| ## API | |||
|
|
|||
| ### activeWin() | |||
| ### activeWin(options) | |||
There was a problem hiding this comment.
Suggested change
| ### activeWin(options) | |
| ### activeWin(options?) |
|
@wrgoto Thanks for your contributions! |
|
@sindresorhus I agree there should be an option for each check, but I haven't verified the extent of removing the accessibility check. I'm not entirely sure if it is limited to the |
|
@sindresorhus are you looking to get this merged soon? |
sindresorhus
requested changes
Mar 7, 2021
index.test-d.ts
Outdated
| @@ -4,7 +4,7 @@ import {Result, LinuxResult, MacOSResult, WindowsResult} from '.'; | |||
|
|
|||
| expectType<Promise<Result | undefined>>(activeWin()); | |||
|
|
|||
| const result = activeWin.sync(); | |||
| const result = activeWin.sync({ screenRecordingPermission: false }); | |||
There was a problem hiding this comment.
Suggested change
| const result = activeWin.sync({ screenRecordingPermission: false }); | |
| const result = activeWin.sync({screenRecordingPermission: false}); |
lib/macos.js
Outdated
|
|
||
| const args = []; | ||
| if (options.screenRecordingPermission === false) { | ||
| args.push('--disable-screen-recording-permission'); |
There was a problem hiding this comment.
Suggested change
| args.push('--disable-screen-recording-permission'); | |
| args.push('--no-screen-recording-permission'); |
--no is the convention for inverted flags.
readme.md
Outdated
| Type: `boolean`\ | ||
| Default: `true` | ||
|
|
||
| Enable the screen recording permission check (macOS). Setting this to `false` will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. |
There was a problem hiding this comment.
Suggested change
| Enable the screen recording permission check (macOS). Setting this to `false` will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. | |
| Enable the screen recording permission check. Setting this to `false` will prevent the screen recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. |
readme.md
Outdated
|
|
||
| ## Result | ||
|
|
||
| Returns a `Promise<Object>` with the result, or `Promise<undefined>` if there is no active window or if the information is not available. |
There was a problem hiding this comment.
Suggested change
| Returns a `Promise<Object>` with the result, or `Promise<undefined>` if there is no active window or if the information is not available. | |
| Returns a `Promise<object>` with the result, or `Promise<undefined>` if there is no active window or if the information is not available. |
readme.md
Outdated
|
|
||
| Type: `object` | ||
|
|
||
| ##### screenRecordingPermission |
There was a problem hiding this comment.
Suggested change
| ##### screenRecordingPermission | |
| ##### screenRecordingPermission **(macOS only)** |
readme.md
Outdated
|
|
||
| ### activeWin.sync() | ||
| #### options |
There was a problem hiding this comment.
You don't need to document the options twice.
index.d.ts
Outdated
| @@ -1,4 +1,15 @@ | |||
| declare namespace activeWin { | |||
| interface Options { | |||
| /** | |||
| Enable the screen recording permission check (macOS). | |||
There was a problem hiding this comment.
Suggested change
| Enable the screen recording permission check (macOS). | |
| Enable the screen recording permission check. _(macOS)_ |
index.d.ts
Outdated
| /** | ||
| Enable the screen recording permission check (macOS). | ||
|
|
||
| Setting this to `false` will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. |
There was a problem hiding this comment.
Suggested change
| Setting this to `false` will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. | |
| Setting this to `false` will prevent the screen recording permission prompt on macOS versions 10.15 and newer. The `title` property in the result will always be set to an empty string. |
index.d.ts
Outdated
|
|
||
| @default true | ||
| */ | ||
| screenRecordingPermission: boolean; |
There was a problem hiding this comment.
Suggested change
| screenRecordingPermission: boolean; | |
| readonly screenRecordingPermission: boolean; |
|
The PR title needs to be updated. |
wrgoto
force-pushed
the
disable-screen-recording
branch
from
5c32311 to
e34d0ae
Compare
wrgoto
force-pushed
the
disable-screen-recording
branch
from
e34d0ae to
1d1aa27
Compare
sindresorhus
changed the title
screenRecordingPermission option
This was referenced Feb 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
One of the significant drawbacks is the library asking for Screen Recording permissions for macOS versions 10.15 and newer. Even though the library doesn't actually record the screen, it is required to get the title of the active window. For those who do not need the window title, there should be an option to forgo the Screen Recording permission check.
Changes
disableScreenRecordingPermissionoption.Related