Skip to content

README.md

Latest commit

 

History

History
79 lines (70 loc) · 3.27 KB

README.md

File metadata and controls

79 lines (70 loc) · 3.27 KB
Raw

Users

License Stable Downloads Vue JavaScript SCSS npm Issues Merge Requests

Description

User administration pages and profile panels for Enso UI.

Installation

Install the package:

yarn add @enso-ui/users

Features

  • ships route-aware page modules consumed by the Enso application shell
  • covers create flows where the backend package exposes them
  • covers edit flows where the backend package exposes them
  • includes index/list pages backed by Enso tables, forms, or integration settings
  • ships reusable page-specific building blocks through deep-import component paths

Usage

<script setup>
import Create from '@enso-ui/users/src/bulma/pages/users/Create.vue';
</script>

API

Route pages

The practical public surface is page-oriented and centered on the route modules shipped by the package.

Pages:

  • src/bulma/pages/users/Create.vue
  • src/bulma/pages/users/Edit.vue
  • src/bulma/pages/users/Index.vue
  • src/bulma/pages/users/Show.vue

Reusable deep-import components

Common reusable modules exposed under src/bulma/pages/*/components:

  • src/bulma/pages/users/components/Avatar.vue
  • src/bulma/pages/users/components/Session.vue
  • src/bulma/pages/users/components/Sessions.vue
  • src/bulma/pages/users/components/Token.vue
  • src/bulma/pages/users/components/TokenForm.vue
  • src/bulma/pages/users/components/Tokens.vue
  • src/bulma/pages/users/components/Url.vue
  • src/bulma/pages/users/components/UserProfile.vue

Routes

Users ships the following named route entries:

  • administration.users.create Path fragment: create/:person Route file: src/bulma/routes/administration/users/create.js
  • administration.users.edit Path fragment: :user/edit Route file: src/bulma/routes/administration/users/edit.js
  • administration.users.index Path fragment: / Route file: src/bulma/routes/administration/users/index.js
  • administration.users.show Path fragment: :user Route file: src/bulma/routes/administration/users/show.js

Companion Backend Package

Depends On

  • No additional Enso UI dependencies.

Contributions

are welcome. Pull requests are great, but issues are good too. Thank you to all the people who already contributed to Enso!

License

MIT