search

hotwax / dxp-components

DXP Components
Apache License 2.0
11 stars 19 forks source link
composable-architecture hacktoberfest pinia pinia-vuejs vue3 vuejs

readme

DXP Components for Vue applications

How to use?

Contribution Guideline

  1. Fork the repository and clone it locally from the main branch. Before starting your work make sure it's up to date with current main branch.
  2. Pick an issue from here. Write in the issue comment that you want to pick it, if you can't assign yourself. Please stay assigned to one issue at a time to not block others.
  3. Create a branch for your edits. Use the following branch naming conventions: dxp-components/issue-number.
  4. Please add issue number to your commit message.
  5. Propose a Pull Request to main branch containing issue number and issue title.
  6. Use Pull Request template (it's automatically added to each PR) and fill as much fields as possible to describe your solution.
  7. Reference any relevant issues or other information in your PR.
  8. Wait for review and adjust your PR according to it.
  9. Congrats! Your PR should now me merged in!

If you can't handle some parts of the issue then please ask for help in the comment. If you have any problems during the implementation of some complex issue, feel free to implement just a part of it.

Report a bug or request a feature

Always define the type of issue:

While writing issues, please be as specific as possible. All requests regarding support with implementation or application setup should be sent to.

Join the community on Discord

If you have any questions or ideas feel free to join our Discord channel

The license

DXP Components is completely free and released under the Apache v2.0 License. Check LICENSE for more details.

Components

DxpTimeZoneSwitcher

TimeZoneSwitcher provides support to select the timeZone for the application. The component uses luxon for managing the dateTime.

Usage

<DxpTimeZoneSwitcher />

DxpTimeZoneSwitcher

Change Date-Time format

You can pass a specific token string in the dateTimeFormat to display the timeZone as per the app. For the possible values of dateTimeFormat, check here.

<DxpTimeZoneSwitcher dateTimeFormat="TTT" />

DxpTimeZoneSwitcher with custom dateTime format

Slots

No slots are available for this component.

Props

Name Description Default Value
showBrowserTimeZone When true displays the timeZone of the browser in the timeZone selector true
showDateTime When true will display the current dateTime as per the timeZone option in the format provided in dateTimeFormat true
dateTimeFormat Pass the specific format in which you want to display the dateTime for the timeZone options. Honored only when showDateTime is true. t ZZZZ

Methods

No methods are available for this component

Events

Name Description
timeZoneUpdated Emitted when timeZone is changed