mirrorform
v0.0.29
Published
Reusable form utilities (custom element).
Downloads
29
Maintainers
rinte0608Readme
mirrorform
再利用可能なフォームユーティリティ（Web Components）
インストール
# npm
npm install mirrorform
# yarn
yarn add mirrorform
# pnpm
pnpm add mirrorform基本的な使用方法
HTML（スタンドアロン）
<!DOCTYPE html>
<html>
<head>
<script
type="module"
src="https://unpkg.com/mirrorform/dist/element.global.js"
></script>
</head>
<body>
<sales-form title="お問い合わせフォーム" endpoint="/api/contact">
</sales-form>
</body>
</html>React
import { SalesFormReact } from "mirrorform/react";
function App() {
return (
<SalesFormReact title="お問い合わせフォーム" endpoint="/api/contact" />
);
}Node.js/ES Modules
import { SalesForm } from "mirrorform";
// Web Components として利用
// HTMLで <sales-form> タグが使用可能になりますカスタムスタイリング
1. カスタムスタイルファイルの作成
パッケージをインストールすると、自動的に mirrorform-style.css ファイルがプロジェクトルートに作成されます。このファイルは自動的に読み込まれるため、css属性を指定する必要はありません。
重要: mirrorform-style.css ファイルは、Web サーバーのドキュメントルート（/mirrorform-style.css）からアクセス可能な場所に配置する必要があります。
フォールバック機能: mirrorform-style.css ファイルが存在しない、または読み込みに失敗した場合、自動的にデフォルトスタイルが適用されます。そのため、カスタムスタイルファイルがなくてもフォームは正常に動作します。
一般的な配置場所：
- 静的サイト:
public/mirrorform-style.cssまたは プロジェクトルート - Next.js:
public/mirrorform-style.css - Vite/Webpack:
public/mirrorform-style.css - Express.js: 静的ファイル提供ディレクトリ内
プロジェクト構成例
Next.js プロジェクト:
my-nextjs-project/
├── public/
│ ├── mirrorform-style.css ← ここに配置
│ └── favicon.ico
├── pages/
│ └── index.js
└── package.jsonVite プロジェクト:
my-vite-project/
├── public/
│ ├── mirrorform-style.css ← ここに配置
│ └── vite.svg
├── src/
│ └── main.js
└── package.json静的サイト:
my-website/
├── mirrorform-style.css ← ここに配置
├── index.html
└── package.jsonファイル移動手順
パッケージインストール後、作成された mirrorform-style.css ファイルを適切な場所に移動してください：
# Next.js / Vite プロジェクトの場合
mv mirrorform-style.css public/
# 静的サイトの場合（既に正しい場所にあります）
# 移動不要手動で作成・再作成したい場合は、以下のコマンドを使用できます：
# npm
npx mirrorform init-styles
# yarn
yarn dlx mirrorform init-styles
# 確認なしで自動作成
npx mirrorform init-styles --auto
# 既存ファイルを上書きする場合
npx mirrorform init-styles --force2. フォームの使用
<sales-form title="お問い合わせフォーム" endpoint="/api/contact"> </sales-form>注意: mirrorform-style.css ファイルは自動的に読み込まれるため、属性で指定する必要はありません。
3. スタイルのカスタマイズ
mirrorform-style.css ファイルを編集して、以下の要素をスタイリングできます：
form- フォーム全体h2- タイトルlabel- ラベルinput[name="name"]- 名前入力フィールドinput[name="company"]- 会社名入力フィールドinput[name="email"]- メールアドレス入力フィールドtextarea[name="message"]- メッセージ入力フィールドbutton- 送信ボタン.status.success- 成功メッセージ.status.error- エラーメッセージ
カスタマイズ例
mirrorform-style.css ファイルに以下のように記述することで、フォームをカスタマイズできます：
/* 名前フィールドに青いボーダーを追加 */
input[name="name"] {
border-left: 4px solid #4299e1;
background: linear-gradient(90deg, #ebf8ff 0%, #ffffff 100%);
}
/* 送信ボタンのカスタマイズ */
button {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
text-transform: uppercase;
letter-spacing: 0.5px;
}
button:hover {
transform: translateY(-2px);
box-shadow: 0 4px 12px rgba(102, 126, 234, 0.4);
}API リファレンス
属性
| 属性 | 型 | デフォルト | 説明 |
| ---------- | ------ | -------------- | ------------------------------ |
| title | string | "Contact us" | フォームのタイトル |
| endpoint | string | "/api/contact" | フォーム送信先のエンドポイント |
注意: 以前のバージョンでは css 属性がありましたが、現在は mirrorform-style.css ファイルが自動的に読み込まれるため不要です。
フォームデータ
送信されるデータの形式：
{
"name": "田中太郎",
"company": "株式会社サンプル",
"email": "[email protected]",
"message": "お問い合わせ内容..."
}サーバーサイドの実装例
Express.js
app.post("/api/contact", express.json(), (req, res) => {
const { name, company, email, message } = req.body;
// バリデーション
if (!name || !email || !message) {
return res.status(400).json({ error: "Required fields are missing" });
}
// メール送信やデータベース保存などの処理
// ...
res.json({ success: true });
});Next.js API Routes
export default async function handler(req, res) {
if (req.method !== "POST") {
return res.status(405).json({ error: "Method not allowed" });
}
const { name, company, email, message } = req.body;
// バリデーション
if (!name || !email || !message) {
return res.status(400).json({ error: "Required fields are missing" });
}
// 処理...
res.json({ success: true });
}ブラウザサポート
- Chrome 54+
- Firefox 63+
- Safari 10.1+
- Edge 79+
ライセンス
MIT
開発・貢献
# クローン
git clone https://github.com/stellaps/form.git
cd form
# 依存関係のインストール
yarn install
# 開発モード
yarn dev
# ビルド
yarn build更新履歴
0.0.8
- カスタムスタイリング機能を追加
mirrorform-style.cssファイルを自動作成・自動読み込みinit-stylesCLI コマンドを追加css属性を削除（固定でmirrorform-style.cssを読み込み）