Skip to content

Conversation

Copy link

Copilot AI commented Oct 24, 2025

Adds comprehensive API reference documentation for macOS-specific View props and events to the React Native macOS docsite.

Changes Made

Created a new API Reference section in the documentation with two comprehensive pages:

View Props (macOS)

Documents all 10 macOS-specific props:

  • acceptsFirstMouse - Control first mouse click behavior when window is inactive
  • allowsVibrancy - Enable macOS vibrancy effects
  • cursor - Custom cursor styles
  • draggedTypes - Drag and drop type configuration
  • enableFocusRing - Focus ring display control
  • focusable - Keyboard focus support
  • keyDownEvents / keyUpEvents - Keyboard event handling with modifier keys
  • mouseDownCanMoveWindow - Window drag behavior control
  • tooltip - Tooltip text display

View Events (macOS)

Documents all 10 macOS-specific events:

  • onFocus / onBlur - Focus management events
  • onKeyDown / onKeyUp - Keyboard events with detailed modifier key support
  • onMouseEnter / onMouseLeave - Mouse hover events with position data
  • onDoubleClick - Double-click handling
  • onDragEnter / onDragLeave / onDrop - Drag and drop events with file data transfer

Each page includes:

  • Detailed descriptions of each prop/event
  • Type information and default values
  • Event data structure documentation
  • Comprehensive code examples
  • Cross-references to related documentation

Documentation Screenshots

API Reference Landing Page

API Reference Category

View Props (macOS)

View Props Page

View Events (macOS)

View Events Page

Validation

  • ✅ Docsite builds successfully with no errors
  • ✅ All pages render correctly with proper navigation
  • ✅ Sidebar integration works as expected
  • ✅ Cross-references link correctly

Fixes #2740

Original prompt

This section details on the original issue you should resolve

<issue_title>[Docsite] Add Pages for macOS only props</issue_title>
<issue_description>We have a lot of macOS only props and events that are defined here: https://github.com/microsoft/react-native-macos/tree/main/packages/react-native/ReactCommon/react/renderer/components/view/platform/macos/react/renderer/components/view and also here: https://github.com/microsoft/react-native-macos/blob/main/packages/react-native/Libraries/NativeComponent/BaseViewConfig.macos.js .

They are not documented on our dosc website: https://github.com/microsoft/react-native-macos/tree/main/docsite . Could we add some pages showing these props?</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Saadnajmi
Copy link
Collaborator

@copilot Can you try again?

Copy link
Author

Copilot AI commented Oct 24, 2025

@copilot Can you try again?

Done! I've successfully created the documentation pages for macOS-specific props and events.

The changes include:

  • New API Reference section in the docs
  • View Props (macOS) page documenting all 10 macOS-specific props
  • View Events (macOS) page documenting all 10 macOS-specific events
  • Code examples and comprehensive descriptions for each

All pages are now live in the docsite and include screenshots showing the rendered documentation. The build completed successfully with no errors.

Commit: 8d8c6a3

Copilot AI changed the title [WIP] Add documentation pages for macOS only props Add documentation pages for macOS only props and events Oct 24, 2025
Copilot finished work on behalf of Saadnajmi October 24, 2025 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docsite] Add Pages for macOS only props

2 participants