Skip to content

Commit

Permalink
cap props type
Browse files Browse the repository at this point in the history
  • Loading branch information
shairez committed Nov 23, 2024
1 parent 9c1e7f6 commit 419772f
Show file tree
Hide file tree
Showing 5 changed files with 425 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .changeset/silent-moons-shave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"qwik-turnstile": patch
---

Captilize props type
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


<h1 align='center'>Qwik Turnstile</h1>
<p align="center">
<img width="400" src="./media/turnstile.gif" alt="Cloudflare Turnstile">
Expand All @@ -21,6 +19,22 @@

</div>

<!-- toc -->

- [Installation](#installation)
- [Usage](#usage)
* [Examples](#examples)
* [🦜 `useTurnstile()` hook](#%F0%9F%A6%9C-useturnstile-hook)
* [`verifyTurnstile()`](#%E2%9C%85-verifyturnstile)
* [🔁 `resetTurnstile()`](#%F0%9F%94%81-resetturnstile)
- [Contributing](#contributing)
- [Code Of Conduct](#code-of-conduct)
- [Contributors](#contributors)
- [Related Links](#related-links)
- [License](#license)

<!-- tocstop -->

## Installation

```console
Expand All @@ -29,6 +43,7 @@ pnpm add qwik-turnstile

## Usage


### 🦜 `useTurnstile()` hook

Add this hook to your Qwik component or route.
Expand All @@ -42,7 +57,7 @@ export default component$(() => {
const { Turnstile, tokenSignal } = useTurnstile(
{
siteKey: import.meta.env.VITE_TURNSTILE_SITEKEY,
onResponse$: $((response) => {
onTokenResponse$: $((response) => {
// set the value of an input field
}),
}
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"release": "changeset publish",
"start": "vite --open --mode ssr",
"test": "echo \"No test specified\" && exit 0",
"toc": "markdown-toc -i README.md --maxdepth 3",
"qwik": "qwik"
},
"peerDependencies": {
Expand All @@ -58,6 +59,7 @@
"dotenv": "^16.4.5",
"eslint": "8.57.0",
"eslint-plugin-qwik": "1.10.0",
"markdown-toc": "^1.2.0",
"np": "^8.0.4",
"prettier": "3.3.3",
"pretty-quick": "^4.0.0",
Expand Down
Loading

0 comments on commit 419772f

Please sign in to comment.