Skip to content

docs: add missing information about status bar props #2953

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 6, 2025
Merged

docs: add missing information about status bar props #2953

merged 3 commits into from
Jun 6, 2025

Conversation

kligarski
Copy link
Contributor

@kligarski kligarski commented May 29, 2025 •
edited
Loading

Description

Add information about supported values for statusBarStyle and statusBarAnimation.

Similar PR in react-navigation: react-navigation/react-navigation#12618, react-navigation.github.io: react-navigation/react-navigation.github.io#1432.

Changes

  • add information about auto and inverted not being supported for statusBarStyle on Android
  • add information about light being default value for statusBarStyle on Android
  • add information about statusBarAnimation default values and differences in behavior between Android and iOS
  • fix missing parenthesis

Checklist

@kligarski kligarski requested a review from kkafar May 29, 2025 08:29
This was referenced May 29, 2025
Merged
Merged
kkafar
kkafar reviewed May 29, 2025
View reviewed changes
Copy link
Member

@kkafar kkafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that change coming from edge-to-edge mode being enabled or did we just miss this information in our documentation.

If it is edge-to-edge related change we should state it explicitly, because not all apps use edge-to-edge.

Otherwise this seems fine. I haven't tested the runtime behaviour, assuming you decided to open this PR for a reason.

satya164 pushed a commit to react-navigation/react-navigation that referenced this pull request May 30, 2025
@kligarski
docs: add missing information in status bar docs (#12618)
d7ca881 
**Motivation**

Recently noticed that docs for `statusBarStyle` and `statusBarHidden`
are not kept in sync between files in `react-native-screens` repo,
`react-naviagtion` in-code docs and `reactnavigation.org/docs`.

I added information about support on Android for `statusBarStyle` and
`statusBarHidden` props and `auto` and `inverted` values not being
supported on Android for `statusBarStyle`.

Similar PR in `react-native-screens`:
software-mansion/react-native-screens#2953,
`react-navigation.github.io`:
react-navigation/react-navigation.github.io#1432.
@kligarski
Copy link
Contributor Author

It is just missing docs (it was already updated in GUIDE_FOR_LIBRARY_AUTHORS.md and react-navigation's docs page but not in some other places, e.g. in-code docs).

When veryfing that these props work, I noticed some problems with statusBarAnimaiton therefore I didn't edit docs for it yet. I'll have a look at this prop later, whether it is impacted by enabling edge-to-edge.

@kligarski kligarski requested a review from kkafar June 2, 2025 08:08
kkafar
kkafar requested changes Jun 2, 2025
View reviewed changes
Copy link
Member

@kkafar kkafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have doubts, whether the reported default values are accurate & also I feel like there is no reason to update /native-stack/ * /src/native-stack. As the whole thing is deprecated anyway.

@kligarski kligarski requested a review from kkafar June 2, 2025 08:49
kkafar
kkafar reviewed Jun 2, 2025
View reviewed changes
Copy link
Member

@kkafar kkafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, thanks for the links. I'm not approving yet, because I wonder whether we need to introduce this as stable behaviour or not :D I'll approve / reject when I make my mind

kkafar
kkafar approved these changes Jun 6, 2025
View reviewed changes
Copy link
Member

@kkafar kkafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kligarski kligarski changed the title docs: add missing information about statusBarStyle docs: add missing information about status bar props Jun 6, 2025
@kligarski kligarski merged commit 599a74f into main Jun 6, 2025
5 checks passed
@kligarski kligarski deleted the @kligarski/fix-status-bar-style-docs branch June 6, 2025 06:00
@kligarski kligarski mentioned this pull request Jun 6, 2025
Merged
satya164 pushed a commit to react-navigation/react-navigation that referenced this pull request Jun 21, 2025
@kligarski
docs: add missing information in statusBarAnimation docs (#12623)
7acb69c 
**Motivation**

This is a follow-up to
#12618 (comment).
Changed the in-code docs for `statusBarAnimation` to match [current
online
docs](https://reactnavigation.org/docs/native-stack-navigator#statusbaranimation).

Similar PR in `react-native-screens`:
software-mansion/react-native-screens#2953.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kkafar kkafar kkafar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kligarski @kkafar