@opendoor/partner-sdk-client-vue 1.0.7-beta.67.1 → 1.0.7-beta.68.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.
- package/README.md +66 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# @opendoor/partner-sdk-client-vue
|
|
2
|
+
|
|
3
|
+
Vue 3 components for Opendoor partner integrations. Address entry, map display, unit confirmation, and DTC onboarding flow with theming support.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @opendoor/partner-sdk-client-vue @opendoor/partner-sdk-client-js-core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Import the CSS in your app entry point:
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import '@opendoor/partner-sdk-client-vue/dist/style.css';
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
```vue
|
|
20
|
+
<script setup lang="ts">
|
|
21
|
+
import {
|
|
22
|
+
OpendoorProvider,
|
|
23
|
+
AddressEntry,
|
|
24
|
+
DtcOnboardingFlow,
|
|
25
|
+
OpendoorClient,
|
|
26
|
+
} from '@opendoor/partner-sdk-client-vue';
|
|
27
|
+
import type { Address } from '@opendoor/partner-sdk-client-js-core';
|
|
28
|
+
import { ref } from 'vue';
|
|
29
|
+
|
|
30
|
+
const client = new OpendoorClient({ baseURL: '/api/opendoor/v1' });
|
|
31
|
+
const address = ref<Address | null>(null);
|
|
32
|
+
|
|
33
|
+
async function handleSelect(addr: Address) {
|
|
34
|
+
address.value = addr;
|
|
35
|
+
// create offer, then show DtcOnboardingFlow
|
|
36
|
+
}
|
|
37
|
+
</script>
|
|
38
|
+
|
|
39
|
+
<template>
|
|
40
|
+
<OpendoorProvider :client="client">
|
|
41
|
+
<AddressEntry @address-select="handleSelect" />
|
|
42
|
+
<!-- After offer created: -->
|
|
43
|
+
<DtcOnboardingFlow
|
|
44
|
+
v-if="address"
|
|
45
|
+
:address="address"
|
|
46
|
+
@submit="
|
|
47
|
+
(answers) => {
|
|
48
|
+
/* submit answers */
|
|
49
|
+
}
|
|
50
|
+
"
|
|
51
|
+
/>
|
|
52
|
+
</OpendoorProvider>
|
|
53
|
+
</template>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Components
|
|
57
|
+
|
|
58
|
+
- **OpendoorProvider** — provide/inject wrapper for the SDK client
|
|
59
|
+
- **AddressEntry** — address autocomplete with manual entry fallback
|
|
60
|
+
- **AddressMap** — static map display via Mapbox geocoding
|
|
61
|
+
- **AddressUnitConfirmation** — unit/apt number collection
|
|
62
|
+
- **DtcOnboardingFlow** — 17-page DTC onboarding questionnaire
|
|
63
|
+
|
|
64
|
+
## Documentation
|
|
65
|
+
|
|
66
|
+
Full guides, API reference, and examples: **https://partner-sdk.opendoor.com**
|