3ef935af.727f8264.js

"use strict";(self.webpackChunkadminforth=self.webpackChunkadminforth||[]).push([[2881],{109:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>d,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/Back/interfaces/AdminForthBulkAction","title":"AdminForthBulkAction","description":"Extends","source":"@site/docs/api/Back/interfaces/AdminForthBulkAction.md","sourceDirName":"api/Back/interfaces","slug":"/api/Back/interfaces/AdminForthBulkAction","permalink":"/docs/api/Back/interfaces/AdminForthBulkAction","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"apiSidebar","previous":{"title":"AdminForthActionInput","permalink":"/docs/api/Back/interfaces/AdminForthActionInput"},"next":{"title":"AdminForthConfig","permalink":"/docs/api/Back/interfaces/AdminForthConfig"}}');var r=s(4848),l=s(8453);const d={},c="AdminForthBulkAction",t={},o=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"action()",id:"action",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"error?",id:"error",level:5},{value:"ok",id:"ok",level:5},{value:"successMessage?",id:"successmessage",level:5},{value:"allowed()?",id:"allowed",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"confirm?",id:"confirm",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"icon?",id:"icon",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"id?",id:"id",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"label",id:"label",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"state?",id:"state",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"successMessage?",id:"successmessage-1",level:3},{value:"Inherited from",id:"inherited-from-5",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"adminforthbulkaction",children:"AdminForthBulkAction"})}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"action",children:"action()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"action"}),": (",(0,r.jsx)(n.code,{children:"__namedParameters"}),") => ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Callback which will be called on backend when user clicks on action button.\nIt should return Promise which will be resolved when action is done."}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Parameter"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"object"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.adminUser"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminUser",children:(0,r.jsx)(n.code,{children:"AdminUser"})})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.resource"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/docs/api/Back/interfaces/AdminForthResource",children:(0,r.jsx)(n.code,{children:"AdminForthResource"})})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.selectedIds"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"any"}),"[]"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.tr"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,r.jsx)(n.code,{children:"key"}),", ",(0,r.jsx)(n.code,{children:"category"}),"?, ",(0,r.jsx)(n.code,{children:"params"}),"?) => ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(n.h5,{id:"error",children:"error?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"error"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h5,{id:"ok",children:"ok"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"ok"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h5,{id:"successmessage",children:"successMessage?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"successMessage"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"allowed",children:"allowed()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"allowed"}),": (",(0,r.jsx)(n.code,{children:"__namedParameters"}),") => ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Allowed callback called to check whether action is allowed for user."}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:"It called first time when user goes to list view. If callback returns false, action button will be hidden on list view."}),"\n",(0,r.jsx)(n.li,{children:"This same callback called second time when user clicks an action button. If callback returns false, action will not be executed.\nIn second time selectedIds will be passed to callback (because checkbox for items are selected), so you can use this to make additional\nchecks ( for example to check if user has permission for certain records )."}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"allowed: async ({ resource, adminUser, selectedIds }) => {\n  if (adminUser.dbUser.role !== 'superadmin') {\n   return false;\n  } \n  return true;\n}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Parameter"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"object"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.adminUser"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminUser",children:(0,r.jsx)(n.code,{children:"AdminUser"})})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"Admin user object"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.allowedActions"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/docs/api/Common/type-aliases/AllowedActionsResolved",children:(0,r.jsx)(n.code,{children:"AllowedActionsResolved"})})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)("p",{children:'Allowed standard actions for current user resolved by calling allowedActions callbacks if they are passed. You can use this variable to rely on standard actions permissions. E.g. if you have custom actions "Mark as read", you  might want to allow it only for users who have "edit" action allowed:'}),(0,r.jsx)("p",{children:"Example:"}),(0,r.jsxs)("code",{children:[(0,r.jsx)("p",{children:"options: {"}),(0,r.jsx)("p",{children:"  bulkActions: ["}),(0,r.jsx)("p",{children:"    {"}),(0,r.jsx)("p",{children:"      label: 'Mark as read',"}),(0,r.jsx)("p",{children:"      action: async ({ resource, recordIds }) => {"}),(0,r.jsx)("p",{children:"        await markAsRead(recordIds);"}),(0,r.jsx)("p",{children:"      },"}),(0,r.jsx)("p",{children:"      allowed: ({ allowedActions }) => allowedActions.edit,"}),(0,r.jsx)("p",{children:"    }"}),(0,r.jsx)("p",{children:"  ],"}),(0,r.jsx)("p",{children:"  allowedActions: {"}),(0,r.jsx)("p",{children:"    edit: ({ resource, adminUser, recordIds }) => {"}),(0,r.jsx)("p",{children:"      return adminUser.dbUser.role === 'superadmin';"}),(0,r.jsx)("p",{children:"    }"}),(0,r.jsx)("p",{children:"  }"}),(0,r.jsx)("p",{children:"}"})]})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"__namedParameters.resource"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/docs/api/Back/interfaces/AdminForthResource",children:(0,r.jsx)(n.code,{children:"AdminForthResource"})})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"-"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"__namedParameters.selectedIds"}),"?"]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"any"}),"[]"]}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"recordIds will be passed only once user tries to perform bulk action by clicking on button"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"confirm",children:"confirm?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"confirm"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Confirmation message which will be displayed to user before action is executed."}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#confirm",children:(0,r.jsx)(n.code,{children:"confirm"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"icon"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Icon for action button which will be displayed in the list view"}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#icon",children:(0,r.jsx)(n.code,{children:"icon"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#id",children:(0,r.jsx)(n.code,{children:"id"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Label for action button which will be displayed in the list view"}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#label",children:(0,r.jsx)(n.code,{children:"label"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"state",children:"state?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"state"}),": ",(0,r.jsx)(n.code,{children:'"danger"'})," | ",(0,r.jsx)(n.code,{children:'"success"'})," | ",(0,r.jsx)(n.code,{children:'"active"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Bulk Action button state 'danger'|success|'active',"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"'danger' - red button"}),"\n",(0,r.jsx)(n.li,{children:"'success' - green button"}),"\n",(0,r.jsx)(n.li,{children:"'active' - blue button"}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#state",children:(0,r.jsx)(n.code,{children:"state"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"successmessage-1",children:"successMessage?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"successMessage"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Success message which will be displayed to user after action is executed."}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon",children:(0,r.jsx)(n.code,{children:"AdminForthBulkActionCommon"})})," . ",(0,r.jsx)(n.a,{href:"/docs/api/Common/interfaces/AdminForthBulkActionCommon#successmessage",children:(0,r.jsx)(n.code,{children:"successMessage"})})]})]})}function a(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var i=s(6540);const r={},l=i.createContext(r);function d(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]);