Skip to content
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

chore: fix react-is readme #5

Merged
merged 1 commit into from
Apr 23, 2023
+2 −5
Merged

chore: fix react-is readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions packages/react-is/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
# `react-is`

**NOTE:** This README is copied directly from React upstream and transpiled to Lua.

This package allows you to test arbitrary values and see if they're a particular React element type.

## Usage

### Determining if a Component is Valid

```lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local React = require(ReplicatedStorage.Packages.React)
local ReactIs = require(ReplicatedStorage.Packages.ReactIs)
local React = require(Path.To.React)
local ReactIs = require(Path.To.ReactIs)

local ClassComponent = React.Component:extend("ClassComponent")