Installations

npm install @capacitor-community/screen-brightness

Pull Requests

Open

0

Total

14

Closed

0

Merged

14

Issues

Open

1

Total

6

Closed

5

Releases

3

v5.0.0

Published on 05 May 2023

v4.0.0

Published on 21 Oct 2022

v2.0.0-0

Published on 05 Aug 2022

View all 3 releases

Developer

capacitor-community

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.18.0

NPM Version

9.8.1 Statistics

23 Stars

37 Commits

8 Forks

2 Watching

4 Branches

20 Contributors

Updated on 21 Nov 2024

Languages

Java (28.64%)

Swift (28.38%)

TypeScript (17.06%)

HTML (11.14%)

JavaScript (8.11%)

Ruby (6.68%)

Total Downloads

Cumulative downloads

Total Downloads

701,092

Last day

-23.2%

1,213

Compared to previous day

Last week

0.5%

7,318

Compared to previous week

Last month

5.9%

35,162

Compared to previous month

Last year

37.7%

325,780

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

1

@capacitor/core

Dev Dependencies

14

eslint rimraf rollup prettier swiftlint typescript @capacitor/ios @capacitor/core @capacitor/docgen @capacitor/android @ionic/eslint-config prettier-plugin-java @ionic/prettier-config @ionic/swiftlint-config

Versions

Screen Brightness

@capacitor-community/screen-brightness

Capacitor community plugin for controlling screen brightness on iOS and Android devices.

Maintainers

Maintainer	GitHub	Social
Ely Lucas	elylucas	@elylucas

Versions

Plugin	Capacitor	Documentation
6.x	6.x	README
5.x	5.x	README
4.x	4.x	README
1.x	3.x	README

Installation

1npm install @capacitor-community/screen-brightness
2npx cap sync

Configuration

No configuration required for this plugin

Usage

1import { ScreenBrightness } from '@capacitor-community/screen-brightness';
2
3// Set the brightness:
4const brightness = 0.5;
5await ScreenBrightness.setBrightness({ brightness });
6
7// Get the current brightness:
8const {brightness: currentBrightness} = await ScreenBrightness.getBrightness();

setBrightness(...)

1setBrightness(options: SetBrightnessOptions) => Promise<void>

Sets the brightness level. On iOS, it sets the system level brightness, and on Android it sets the brightness for the current view.

Param	Type	Description
`options`	`SetBrightnessOptions`	Options to set brightness

Since: 1.0.0

getBrightness()

1getBrightness() => Promise<GetBrightnessReturnValue>

Returns info than contains the current brightness level

@since 1.0.0

Returns: Promise<GetBrightnessReturnValue>

Interfaces

SetBrightnessOptions

Prop	Type	Description	Since
`brightness`	`number`	The level to set the brightness to, from 0.0 (very dim) to 1.0 (full brightness) On Android, setting the value to -1 restores the user configured brightness.	1.0.0

GetBrightnessReturnValue

Prop	Type	Description	Since
`brightness`	`number`	The current brightness level, from 0.0 (very dim) to 1.0 (full brightness) On Android it returns -1 if the value has not been changed by the app.	1.0.0

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More