Skip to content

Enhancement: Add Platform API Doc #1509

Closed

Description

@hramos

The Platform module does not have a dedicated API doc (e.g. a dedicated entry under the API sub-group in the API reference). It is documented under Platform specific code at https://facebook.github.io/react-native/docs/platform-specific-code#platform-module. For discoverability and completeness, I believe this module deserves to have its own API doc at https://facebook.github.io/react-native/docs/platform (Under the API -> APIs sidebar menu).

Activity

  1. added
    👋 Good first issueInterested in collaborating? Take a stab at fixing one of these issues.
    on Apr 16, 2020
  2. Simek commented on Apr 16, 2020

    @Simek
    Collaborator

    +1 since PlatformColor will receive its own page too.

    The current implementation of this API can be found here:

  3. zanona commented on May 26, 2020

    @zanona

    I completely agree, It's curious that the first example on https://reactnative.dev/docs/platform-specific-code#platform-module starts with

    import { Platform, StyleSheet } from 'react-native';

    Where StyleSheet is listed under the API dropdown but Platform isn't.
    Took me a while to find it. 😃

  4. Tundeh commented on Jul 30, 2020

    @Tundeh

    Can i take this issue?
    also, I'm new here.

  5. Naturalclar commented on Nov 25, 2020

    @Naturalclar
    Contributor

    @Tundeh are you still willing to work on this issue?
    Any help would be appreciated 😄

  6. Tundeh commented on Nov 25, 2020

    @Tundeh

    @Tundeh are you still willing to work on this issue?
    Any help would be appreciated 😄

    Yes. I'm interested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    👻 Missing DocsDocumentation is missing👋 Good first issueInterested in collaborating? Take a stab at fixing one of these issues.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions