foundation-entity-management.users
Home > @genesislcap/foundation-entity-management > Users
Users class
Main class which defines the user management functionality
Signature:
export declare class Users extends Users_base
Extends: Users_base
Remarks
Under the hood the user-management is the entity-management micro-frontend configured for use with the ALL_USERS
resource.
Example
With no customisation required the user management micro-frontend can simply be dropped into the template as shown. However, it is advised to wrap it in an error boundary component.
<user-management></user-management>
With this default example above the columns will be the UsersColumnConfig as well as the entity and status columns. The entity and status columns are always added regardless of the other columns which are configured.
You can add in additional customisation options. For example you can define a custom column and then mix-in with the standard columns
import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';
const userColumns = [
{
field: 'ACCESS_TYPE',
headerName: 'Access Type',
},
];
// Definition inside of the html template
<user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)() | Constructor will set the Users.createEvent Users.deleteEvent Users.updateEvent to match the permissions set from the server |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
additionalCreateFields | any | ||
additionalUpdateFields | any | ||
allAccessType | boolean | ||
columns | any | Column definition, default to the UsersColumnConfig | |
createEvent | string | String which contains event if we have permission to insert user of empty string if not | |
deleteEvent | string | String which contains event if we have permission to delete user of empty string if not | |
gridOptions | GridOptions | GridOptions to be passed down from application | |
persistColumnStateKey | string | This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to entity_users_management . | |
updateEvent | string | String which contains event if we have permission to update user of empty string if not |
Methods
Method | Modifiers | Description |
---|---|---|
connectedCallback() | ||
deepClone() |