@molecule/app-address-display-react 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +136 -0
  2. package/package.json +14 -8
package/README.md ADDED
@@ -0,0 +1,136 @@
1
+ <!--
2
+ AUTO-GENERATED — DO NOT EDIT THIS FILE.
3
+ Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
4
+ Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
5
+ To change this document, edit the module-level JSDoc in src/index.ts.
6
+ Generated: 2026-08-04T01:49:52.672Z
7
+ -->
8
+
9
+ # @molecule/app-address-display-react
10
+
11
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
12
+ > It is written to be read by coding agents as much as by people, and is generated from this
13
+ > package's source — edit `src/index.ts` JSDoc, not this file.
14
+
15
+ Address display.
16
+
17
+ Exports `<AddressDisplay>` — formatted multi-line (or inline) address with
18
+ name, phone, leading icon, and action slots.
19
+ Also exports the `Address` type.
20
+
21
+ ## Quick Start
22
+
23
+ ```tsx
24
+ import { AddressDisplay } from '@molecule/app-address-display-react'
25
+
26
+ ;<AddressDisplay
27
+ name="Jane Smith"
28
+ address={{
29
+ line1: '123 Main St',
30
+ city: 'Springfield',
31
+ state: 'IL',
32
+ postalCode: '62701',
33
+ country: 'US',
34
+ }}
35
+ phone="+1 555-867-5309"
36
+ />
37
+ ```
38
+
39
+ ## Type
40
+
41
+ `feature`
42
+
43
+ ## Installation
44
+
45
+ ```bash
46
+ npm install @molecule/app-address-display-react @molecule/app-react @molecule/app-ui @molecule/app-ui-react react
47
+ npm install -D @types/react
48
+ ```
49
+
50
+ ## API
51
+
52
+ ### Interfaces
53
+
54
+ #### `Address`
55
+
56
+ Structured postal address with optional individual fields.
57
+
58
+ ```typescript
59
+ interface Address {
60
+ /** First line — street + number. */
61
+ line1?: string
62
+ /** Second line — apartment, suite, unit. */
63
+ line2?: string
64
+ /** City. */
65
+ city?: string
66
+ /** State / province / region. */
67
+ state?: string
68
+ /** ZIP / postal code. */
69
+ postalCode?: string
70
+ /** Country. */
71
+ country?: string
72
+ }
73
+ ```
74
+
75
+ #### `AddressDisplayProps`
76
+
77
+ Props for {@link AddressDisplay}.
78
+
79
+ ```typescript
80
+ interface AddressDisplayProps {
81
+ /** Address fields. */
82
+ address: Address
83
+ /** Optional name / label preceding the address. */
84
+ name?: ReactNode
85
+ /** Optional phone number rendered under the address. */
86
+ phone?: string
87
+ /** Optional `<Icon>` / avatar leading slot. */
88
+ leading?: ReactNode
89
+ /** Optional right-side actions. */
90
+ actions?: ReactNode
91
+ /** Format as a single line instead of multi-line. */
92
+ inline?: boolean
93
+ /** Extra classes. */
94
+ className?: string
95
+ }
96
+ ```
97
+
98
+ ### Functions
99
+
100
+ #### `AddressDisplay(props)`
101
+
102
+ Formatted multi-line address display with optional name, phone,
103
+ leading slot, and right-side actions. Set `inline` to render all
104
+ fields on a single line (e.g., in a table cell).
105
+
106
+ ```typescript
107
+ function AddressDisplay({
108
+ address,
109
+ name,
110
+ phone,
111
+ leading,
112
+ actions,
113
+ inline,
114
+ className,
115
+ }: AddressDisplayProps): ReactElement<unknown, string | JSXElementConstructor<any>>
116
+ ```
117
+
118
+ - `props` — Component props (see {@link AddressDisplayProps}).
119
+
120
+ ## Injection Notes
121
+
122
+ ### Requirements
123
+
124
+ Peer dependencies:
125
+
126
+ - `@molecule/app-react` ^1.0.1
127
+ - `@molecule/app-ui` ^1.0.1
128
+ - `@molecule/app-ui-react` ^1.0.1
129
+ - `react` ^18.0.0 || ^19.0.0
130
+
131
+ ### Runtime Dependencies
132
+
133
+ - `@molecule/app-react`
134
+ - `@molecule/app-ui`
135
+ - `@molecule/app-ui-react`
136
+ - `react`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@molecule/app-address-display-react",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Formatted multi-line address card with edit/delete actions",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -17,7 +17,8 @@
17
17
  }
18
18
  },
19
19
  "files": [
20
- "dist"
20
+ "dist",
21
+ "README.md"
21
22
  ],
22
23
  "keywords": [
23
24
  "molecule",
@@ -25,16 +26,21 @@
25
26
  "react"
26
27
  ],
27
28
  "license": "Apache-2.0",
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "https://github.com/molecule-dev/molecule.git",
32
+ "directory": "packages/app/features/address-display-react"
33
+ },
28
34
  "peerDependencies": {
29
- "@molecule/app-react": "^1.0.0",
30
- "@molecule/app-ui": "^1.0.0",
31
- "@molecule/app-ui-react": "^1.0.0",
35
+ "@molecule/app-react": "^1.0.1",
36
+ "@molecule/app-ui": "^1.0.1",
37
+ "@molecule/app-ui-react": "^1.0.1",
32
38
  "react": "^18.0.0 || ^19.0.0"
33
39
  },
34
40
  "devDependencies": {
35
- "@molecule/app-react": "1.0.0",
36
- "@molecule/app-ui": "1.0.0",
37
- "@molecule/app-ui-react": "1.0.0",
41
+ "@molecule/app-react": "1.0.1",
42
+ "@molecule/app-ui": "1.0.1",
43
+ "@molecule/app-ui-react": "1.0.1",
38
44
  "@types/node": "26.1.2",
39
45
  "@types/react": "19.2.17",
40
46
  "@types/react-dom": "19.2.3",