whelk-ui

Whelk UI

A dumb component library built with Vue 3. Simple, effective, and small!

Please note

Whelk UI is currently in active development and is not recommended for production environments just yet.

Why Whelk UI?

Each component is designed to be as simple/dumb as possible. The business logic is left to the consumer to implement. Giving the consumer the freedom to implement the logic they want easily and quickly. Thing of Whelk UI as a bunch of shell components that you can use to build your own application.

We are currently building out Whelk UI for NearBeach and a future project. We are building it with the requirements we need for both these projects.

Available Components

To keep Whelk UI components as dumb as possible, there are specific components that deal with only one specific user case. For example, the PasswordInput has been created to handle just passwords. Keeping the TextInput as simple/dumb as possible.

• Button
• Card
  • Card Header
  • Card Footer
• CheckBox
• Date
• Datetime
• Dropdown
  • DropDownItem
  • DropDownSeparator
• FormGroup
• Modal
  • ModalFooter
  • ModalHeader
• MultiSelect
• NumberInput
• PasswordInput
• RenderErrorMessage
• Select
  • SelectRenderOptionGroups
  • SelectRenderOptions
• Switch
• Tabs
  • TabHeader
• TextArea
• TextInput
• Time
• ToolTip

Getting Started

To install Whelk UI, you can use NPM

npm install -D whelk-ui

Use the component guides on how to utilise each component on your Vue project.

Helpful Links

If you are interested in the development process of Whelk UI, you can visit our kanban board.

If you would like to give feedback or request features, you are more than welcome to join our discord.