Skip to content

Commit

Permalink
Merge pull request #16 from jamsubu/feat/docs-readme
Browse files Browse the repository at this point in the history
feat: import readme from root
  • Loading branch information
nakzyu authored May 21, 2024
2 parents c8a2ebd + d538371 commit a655250
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 22 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# Headlessui React Native
<h1 align="center">
Headlessui React Native
</h1>

This is an unstyled, accessible headless UI library for React Native.

If you have nativewind installed, you can also use tailwind. Visit following website to see the full API documentation https://headlessui-react-native.vercel.app

## Package

| Name | Version | Downloads |
| :------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: |
| [`headlessui-react-native`](https://github.com/jamsubu/headlessui-react-native/tree/main/packages/headlessui-react-native) | [![npm version](https://img.shields.io/npm/v/headlessui-react-native)](https://www.npmjs.com/package/headlessui-react-native) | [![npm downloads](https://img.shields.io/npm/dt/headlessui-react-native)](https://www.npmjs.com/package/headlessui-react-native) |

## Goals

The goal of this project is to provide React Native developers with a seamless experience in using certain mobile-friendly components from headless UI packages, without the cognitive stress of significant alterations. Thus, most of the input, output, and concepts of headless UI components can be utilized without major adjustments.
Expand Down
57 changes: 56 additions & 1 deletion apps/docs/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,62 @@ import { DocsThemeConfig } from "nextra-theme-docs";
import React from "react";

const config: DocsThemeConfig = {
logo: <span>Headlessui React Native</span>,
logo: (
<div
style={{
display: "flex",
alignItems: "center",
justifyContent: "center",
}}
>
<svg
width="24"
height="24"
viewBox="0 0 280 280"
xmlns="http://www.w3.org/2000/svg"
fill="black"
>
<mask id="subtract">
<path
x="0"
y="0"
width="280"
height="280"
d="M0 53C0 23.7289 23.7289 0 53 0H227C256.271 0 280 23.7289 280 53V227C280 256.271 256.271 280 227 280H53C23.7289 280 0 256.271 0 227V53Z"
fill="white"
></path>
<rect
x="0"
y="30%"
width="280"
height="112"
rx="38"
fill="black"
transform="rotate(135 140 140)"
></rect>
</mask>
<path
mask="url(#subtract)"
x="0"
y="0"
width="280"
height="280"
d="M0 53C0 23.7289 23.7289 0 53 0H227C256.271 0 280 23.7289 280 53V227C280 256.271 256.271 280 227 280H53C23.7289 280 0 256.271 0 227V53Z"
></path>
</svg>

<span
style={{
fontWeight: "bold",
fontSize: "1.5rem",
marginLeft: "0.25rem",
height: "fit-content",
}}
>
HeadlessUI React Native
</span>
</div>
),
project: {
link: "https://github.com/jamsubu/headlessui-react-native",
},
Expand Down
19 changes: 0 additions & 19 deletions packages/headlessui-react-native/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion packages/headlessui-react-native/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
},
"scripts": {
"dev": "concurrently \"swc ./src -d ./dist --watch\" \"tsc -w\"",
"build": "swc ./src -d ./dist && tsc",
"build": "swc ./src -d ./dist && tsc && cp ../../README.md .",
"prepublishOnly": "yarn build"
}
}

1 comment on commit a655250

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for headlessui-react-native-docs ready!

✅ Preview
https://headlessui-react-native-docs-qqv9x4c0z-nakzyus-projects.vercel.app

Built with commit a655250.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.