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.

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

Conform docs #317

Merged
merged 12 commits into from
Apr 29, 2024
Merged

Conform docs #317

merged 12 commits into from
Apr 29, 2024

Conversation

AkifumiSato
Copy link
Contributor

No description provided.

Copy link

changeset-bot bot commented Apr 23, 2024

⚠️ No Changeset found

Latest commit: b880950

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@AkifumiSato AkifumiSato marked this pull request as ready for review April 23, 2024 05:28
Copy link
Member

@koichik koichik left a comment

Choose a reason for hiding this comment

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

乙でした!
先頭小文字のconformで揃ってるけど公式ドキュメントは先頭大文字のConformですよね
https://conform.guide

まぁ、英語圏の人たちは日本人が思ってるより大文字小文字を気にしない感じだけど
Conformもロゴ画像は全部大文字だし
基本的には公式ドキュメントに合わせるってことで先頭は大文字がいい気がしました

packages/location-state-conform/README.md Outdated Show resolved Hide resolved
packages/location-state-conform/README.md Outdated Show resolved Hide resolved
packages/location-state-conform/docs/API.md Show resolved Hide resolved
packages/location-state-conform/docs/API.md Outdated Show resolved Hide resolved
packages/location-state-conform/docs/API.md Outdated Show resolved Hide resolved
packages/location-state-conform/docs/API.md Outdated Show resolved Hide resolved
packages/location-state-conform/docs/API.md Outdated Show resolved Hide resolved
packages/location-state-conform/docs/API.md Show resolved Hide resolved
packages/location-state-conform/README.md Outdated Show resolved Hide resolved
Copy link
Member

@koichik koichik left a comment

Choose a reason for hiding this comment

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

LGTMです!乙でした!

@AkifumiSato AkifumiSato merged commit 4a6c16c into conform Apr 29, 2024
@AkifumiSato AkifumiSato deleted the conform-docs branch April 29, 2024 10:08
AkifumiSato added a commit that referenced this pull request May 13, 2024
* docs: `@location-state/conform` README

* docs: `@location-state/conform` API docs

* docs: `@location-state/confrom` docs fix

* docs: `@location-state/conform` fix Quickstart text

* docs: `@location-state/conform` example of Server Actions or nothing.

* docs: `@location-state/conform` useLocationForm type fix

* docs: `@location-state/conform` add conform's `id` link.

* docs: `@location-state/conform` fix useLocationForm return text.

* docs: `@location-state/conform` fix GetLocationFormProps return text.

* docs: `@location-state/conform` fix GetLocationFormProps return text.

* docs: `@location-state/conform` fix feature explain.

* docs: `@location-state/conform` fix API explain.

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>
AkifumiSato added a commit that referenced this pull request May 13, 2024
* examples: confrom init (#279)

* examples: confrom init

* example: conform example: use src directory, add next.config.js

* example: conform example's remove button not working

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>

* Conform example with `useLocationForm` (#286)

* example: confrom wrapper module

* example: restore location state form

* example: refactor useLocationForm type

* example: useLocationForm return with form props

* example: refactor&comment useLocationForm

* example: fix state name

* example: useForm behavoir test

* example: useLocationForm refactor rm typeof window

* example: useLocationForm fix return value

* example: fix useSyncExternalStore 1st arg same ref

* example: dynamic form item restore

* example: useLocationForm with dynamic form

* example: fix effect callback to useEffect

* example: getLocationFormProps memo

* feat: useLocationGetState impl

* example: useLocationForm with getLocationState

* example: fix onChange save location state

* example: @types/lodash.set add

* example: rm (dynamic)

* example: useLocationFrom option add id

* example: fix useLocationFrom checkbox restore

* example: useLocationForm add comment

* example: useLocationForm refactor noop name

* example: rm unused import

* example: (not use location state) conform search form

* example: useLocationForm sync url exmaple

* example: url useLocationForm example

* example: fix useLocationForm onChange default value

* example: refactor package, key

* example: useLocationForm refactor

* example: useLocationForm rendering optimize

* rebase on conform branch, update lock file

* example: useLocationForm callback deps fix

* refactor: useLocationForm option idPrefix rename

* feat: useLocationForm API fix

* fix: useLocationForm type

* refactor: useLocationForm re-render hooks useReducer

* refactor: useLocationForm add ref guard check

* fix: useLocationForm formOption fix

* feat: `filterFormValueWihZodShape` add

* fix: useLocationForm id setting timing

* fix: useLocationForm initial id set

* refactor: filterFormValueWihZodShape no use zod

* fix: useLocationForm inital id set

* fix: useLocationForm schema option add

* refactor: rename useLocationForm inner vars

* test: conform example e2e add

* example: useLocationForm option rm shape

* example: rename static form

* example: simple form with conform

* refactor: vars order fix

* refactor: fix defenition order

* feat: `useLocationKey` impl

* example: refactor rm lodash.set

* refactor: useLocationForm

* refactor: updateWithObjectPath

* example: type spec simple form

* example: simple conform submit redirect

* refactor: declarative order

* refactor: rename inner vars

* refactor: getPaths

* refactor: useLocationKey subscribe

* feat: useLocationKey option

* todo comment

* fix: useLocationKey default args

* fix: useLocationForm support intent

* refactor: useLocationForm console rm

* fix: simple form unnecessary if rm

* example: dynamic form add first button

* example: number's error field

* example: refactor schema

* fix: conform example test

* example: simple-form refactor

* example: static-from refactor

* refactor: useLocationForm

* example: simple/static form content

* example: test comment fix

* example: fix number error message

* example: dynamic form reset button impl

* example: submit/reset button layout

* example: rename schema

* refactor: conform page

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>

* chore: vsc setting update (#309)

Co-authored-by: akfm.sato <01047245@CF0286.local>

* `@location-state/conform` package init (#313)

* feat: @location-state/conform init

* refactor: confrom src directory

* refactor: @location-state/confrom strict check

* refactor: updatedWithObjectPath test

* refactor: updatedWithObjectPath

* refactor: updateWithObjectPath

* refactor: useLocationForm

* refactor: updatedWithObjectPath type assert refactor

* refactor: @repo/utils, @repo/test-utils

* refactor: rename configs to @repo/configs

* refactor: rename test case

* refactor: type utils

* feat: useLocationForm use valibot validation

* refactor: add comment

* fix: @location-state/confrom package.json fix description/dependencies

* refactor: updateWithObjectPath test

* refactor: format

* tsconfig update

* feat: @location-state/conform dependencies/description fix

* refactor: move comment to schema.ts

* refactor: test define member order fix

* refactor: comment fix, AssertError impl

* test: @location-state/conform test

* refactor: @location-state/conform array utils impl

* refactor: update-array test

* refactor: update-array test name fix

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>

* Conform docs (#317)

* docs: `@location-state/conform` README

* docs: `@location-state/conform` API docs

* docs: `@location-state/confrom` docs fix

* docs: `@location-state/conform` fix Quickstart text

* docs: `@location-state/conform` example of Server Actions or nothing.

* docs: `@location-state/conform` useLocationForm type fix

* docs: `@location-state/conform` add conform's `id` link.

* docs: `@location-state/conform` fix useLocationForm return text.

* docs: `@location-state/conform` fix GetLocationFormProps return text.

* docs: `@location-state/conform` fix GetLocationFormProps return text.

* docs: `@location-state/conform` fix feature explain.

* docs: `@location-state/conform` fix API explain.

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>

* fix: conform update error. (#345)

Co-authored-by: akfm.sato <01047245@CF0286.local>

* Conform prepare release (#326)

* docs: add changeset of `@location-state/conform`.

* docs: `useLocationKey`, `useLocationGetState` explain API docs.

* docs: fix changesets.

* docs: split changesets docs

* docs: fix `useLocationKey` / `useLocationGetState`

* docs: fix `useLocationGetState`/``useLocationKey` description word.

* chore: pnpm update version specify

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>

* chore: fix pnpm version, fix rebase diff

* chore: rm apps/example-next-conform dependencies playwright

* fix: vscode setting json nits, `useLocationKey` docs

---------

Co-authored-by: akfm.sato <01047245@CF0286.local>
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.

None yet

2 participants