Skip to content

Commit

Permalink
doc(contacts): readme
Browse files Browse the repository at this point in the history
  • Loading branch information
angelo-v committed Feb 21, 2024
1 parent 4d0cb83 commit adefec8
Show file tree
Hide file tree
Showing 10 changed files with 381 additions and 2 deletions.
60 changes: 60 additions & 0 deletions contacts/src/components/address-book-page/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# pos-contacts-address-book-page



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ---------------- | --------- | ----------- | ---------------- | ----------- |
| `contactsModule` | -- | | `ContactsModule` | `undefined` |
| `uri` | `uri` | | `string` | `undefined` |


## Dependencies

### Used by

- [pos-contacts-router](../router)

### Depends on

- ion-icon
- pos-login
- [pos-contacts-group-list](../group-list)
- [pos-contacts-contact-details](../contact-details)
- [pos-contacts-group-details](../contact-details/group-details)
- [pos-contacts-contact-list](../contact-list)

### Graph
```mermaid
graph TD;
pos-contacts-address-book-page --> ion-icon
pos-contacts-address-book-page --> pos-login
pos-contacts-address-book-page --> pos-contacts-group-list
pos-contacts-address-book-page --> pos-contacts-contact-details
pos-contacts-address-book-page --> pos-contacts-group-details
pos-contacts-address-book-page --> pos-contacts-contact-list
pos-login --> pos-resource
pos-login --> pos-picture
pos-login --> pos-label
pos-login --> ion-button
pos-resource --> ion-progress-bar
pos-resource --> ion-card
pos-resource --> ion-card-header
pos-resource --> ion-card-content
ion-card --> ion-ripple-effect
pos-picture --> pos-image
pos-image --> ion-skeleton-text
ion-button --> ion-ripple-effect
pos-contacts-contact-details --> pos-contacts-phone-numbers
pos-contacts-contact-details --> pos-contacts-email-addresses
pos-contacts-router --> pos-contacts-address-book-page
style pos-contacts-address-book-page fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
30 changes: 30 additions & 0 deletions contacts/src/components/contact-details/email-addresses/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# pos-contacts-email-addresses



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ----------------------------- | --------- | ----------- | --------- | ----------- |
| `emailAddresses` _(required)_ | -- | | `Email[]` | `undefined` |


## Dependencies

### Used by

- [pos-contacts-contact-details](..)

### Graph
```mermaid
graph TD;
pos-contacts-contact-details --> pos-contacts-email-addresses
style pos-contacts-email-addresses fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
31 changes: 31 additions & 0 deletions contacts/src/components/contact-details/group-details/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# pos-contacts-group-details



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ----------------------------- | --------- | ----------- | ---------------- | ----------- |
| `contactsModule` _(required)_ | -- | | `ContactsModule` | `undefined` |
| `uri` _(required)_ | `uri` | | `string` | `undefined` |


## Dependencies

### Used by

- [pos-contacts-address-book-page](../../address-book-page)

### Graph
```mermaid
graph TD;
pos-contacts-address-book-page --> pos-contacts-group-details
style pos-contacts-group-details fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
30 changes: 30 additions & 0 deletions contacts/src/components/contact-details/phone-numbers/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# pos-contacts-phone-numbers



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| --------------------------- | --------- | ----------- | --------------- | ----------- |
| `phoneNumbers` _(required)_ | -- | | `PhoneNumber[]` | `undefined` |


## Dependencies

### Used by

- [pos-contacts-contact-details](..)

### Graph
```mermaid
graph TD;
pos-contacts-contact-details --> pos-contacts-phone-numbers
style pos-contacts-phone-numbers fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
45 changes: 45 additions & 0 deletions contacts/src/components/contact-details/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# pos-contacts-contact-details



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ----------------------------- | --------- | ----------- | ---------------- | ----------- |
| `contactsModule` _(required)_ | -- | | `ContactsModule` | `undefined` |
| `uri` _(required)_ | `uri` | | `string` | `undefined` |


## Events

| Event | Description | Type |
| -------------------------------- | ----------- | ------------------- |
| `pod-os-contacts:contact-closed` | | `CustomEvent<void>` |


## Dependencies

### Used by

- [pos-contacts-address-book-page](../address-book-page)

### Depends on

- [pos-contacts-phone-numbers](phone-numbers)
- [pos-contacts-email-addresses](email-addresses)

### Graph
```mermaid
graph TD;
pos-contacts-contact-details --> pos-contacts-phone-numbers
pos-contacts-contact-details --> pos-contacts-email-addresses
pos-contacts-address-book-page --> pos-contacts-contact-details
style pos-contacts-contact-details fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
37 changes: 37 additions & 0 deletions contacts/src/components/contact-list/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# pos-contacts-contact-list



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ----------------------- | --------- | ----------- | ----------- | ----------- |
| `contacts` _(required)_ | -- | | `Contact[]` | `undefined` |


## Events

| Event | Description | Type |
| ---------------------------------- | ----------- | ---------------------- |
| `pod-os-contacts:contact-selected` | | `CustomEvent<Contact>` |


## Dependencies

### Used by

- [pos-contacts-address-book-page](../address-book-page)

### Graph
```mermaid
graph TD;
pos-contacts-address-book-page --> pos-contacts-contact-list
style pos-contacts-contact-list fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
37 changes: 37 additions & 0 deletions contacts/src/components/group-list/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# pos-contacts-group-list



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| -------- | --------- | ----------- | --------- | ----------- |
| `groups` | -- | | `Group[]` | `undefined` |


## Events

| Event | Description | Type |
| -------------------------------- | ----------- | -------------------- |
| `pod-os-contacts:group-selected` | | `CustomEvent<Group>` |


## Dependencies

### Used by

- [pos-contacts-address-book-page](../address-book-page)

### Graph
```mermaid
graph TD;
pos-contacts-address-book-page --> pos-contacts-group-list
style pos-contacts-group-list fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
4 changes: 2 additions & 2 deletions contacts/src/components/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@

### Used by

- [pos-contacts](.)
- [pos-contacts-router](router)

### Graph
```mermaid
graph TD;
pos-contacts --> pos-contacts-group
pos-contacts-router --> pos-contacts-group
style pos-contacts-group fill:#f9f,stroke:#333,stroke-width:4px
```

Expand Down
62 changes: 62 additions & 0 deletions contacts/src/components/router/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# pos-contacts-router



<!-- Auto Generated Below -->


## Events

| Event | Description | Type |
| ------------- | ----------- | ------------------ |
| `pod-os:init` | | `CustomEvent<any>` |


## Dependencies

### Used by

- [pos-contacts-app](..)

### Depends on

- [pos-contacts-welcome-page](../welcome-page)
- [pos-contacts-address-book-page](../address-book-page)
- [pos-contacts-contact](..)
- [pos-contacts-group](..)

### Graph
```mermaid
graph TD;
pos-contacts-router --> pos-contacts-welcome-page
pos-contacts-router --> pos-contacts-address-book-page
pos-contacts-router --> pos-contacts-contact
pos-contacts-router --> pos-contacts-group
pos-contacts-welcome-page --> pos-login
pos-login --> pos-resource
pos-login --> pos-picture
pos-login --> pos-label
pos-login --> ion-button
pos-resource --> ion-progress-bar
pos-resource --> ion-card
pos-resource --> ion-card-header
pos-resource --> ion-card-content
ion-card --> ion-ripple-effect
pos-picture --> pos-image
pos-image --> ion-skeleton-text
ion-button --> ion-ripple-effect
pos-contacts-address-book-page --> ion-icon
pos-contacts-address-book-page --> pos-login
pos-contacts-address-book-page --> pos-contacts-group-list
pos-contacts-address-book-page --> pos-contacts-contact-details
pos-contacts-address-book-page --> pos-contacts-group-details
pos-contacts-address-book-page --> pos-contacts-contact-list
pos-contacts-contact-details --> pos-contacts-phone-numbers
pos-contacts-contact-details --> pos-contacts-email-addresses
pos-contacts-app --> pos-contacts-router
style pos-contacts-router fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
Loading

0 comments on commit adefec8

Please sign in to comment.