Is it possible to add extra fields to the user collection using a plugin?

bruvimtired8 months ago

11

• 

  notchr8 months ago

  You can

  
  

  
  

  So its a User collection?

• 

  bruvimtired8 months ago

  @notchris Yeah

• 

  notchr8 months ago

  also

  
  

  
  

  Wait so this is a checkbox field

  
  

  
  

  on the user collection

• 

  bruvimtired8 months ago

  Yeah, so when you install the plugin I want it to add a checkbox field to the user collection

• 

  notchr8 months ago

  import type { Plugin } from 'payload/config'
  
  export const addCheckboxExamplePlugin =
    (pluginOptions: {}): Plugin =>
    incomingConfig => {
      let config = { ...incomingConfig }
  
      config.collections = [...(config.collections || [])]
  
      if (config.collections !== undefined) {
        const userCollection = config.collections.find((collection) => collection.slug === 'User')
        userCollection.fields = [
          ...userCollection.fields,
          {
              name: 'exampleField',
              type: 'checkbox', // required
              label: 'Click me to see fanciness',
              defaultValue: false,
          }
        ]
      }
  
      config.onInit = async payload => {
        if (incomingConfig.onInit) await incomingConfig.onInit(payload)
      }
  
      return config
    }

  
  

  
  

  Something like that

  
  

  
  

  You probs want to add a check to make sure

  const userCollection = config.collections.find((collection) => collection.slug === 'User')

  exists

• 

  bruvimtired8 months ago

  I could maybe just use

  incomingConfig.admin.user.slug

  instead of 'User'?

• 

  notchr8 months ago

  like

  
  
  

  if (userCollection) {...}

  
  

  
  

  well, if you can check to make sure incomingConfig has the slug you need then yes

• 

  bruvimtired8 months ago

  Okay thanks @notchris let me try this

• 

  notchr8 months ago

  Let me know how it goes!

• 

  bruvimtired8 months ago

  @notchris It worked! thanks

  
  

  
  

  if (config.collections !== undefined) {
    const userCollection = config.collections.find(collection => collection.slug === incomingConfig.admin?.user);
    if (userCollection) {
      userCollection.fields = [
        ...userCollection.fields,
        {
          name: "exampleField",
          type: "checkbox", // required
          label: "Click me to see fanciness",
          defaultValue: false,
        },
      ];
    }
  }

• 

  notchr8 months ago

  Nicely done!!