---
title: Customize Property Editors
product: Survey Creator
description: The Survey Creator library lets you customize property editors to create new custom properties or modify the built-in ones. View a free demo for JavaScript.
framework: Vue 3
source: https://surveyjs.io/survey-creator/examples/customize-property-editors/vue3js
index: https://surveyjs.io/survey-creator/examples/overview.md
---

# Customize Property Editors (Vue 3)

The Property Grid allows you to register custom property editors and use them for built-in and custom properties. The editors are based on question types from SurveyJS Form Library. For instance, this example shows how to use the [Single-Line Input](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model) question type to implement a text editor [limited to 15 characters](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#maxLength). This editor is used for the **Question name** and **Short name** properties.

Each property editor type is a configuration object that specifies at least two functions:

- `getJSON`: `Function`         
Returns the JSON configuration object of an underlying SurveyJS Form Library question. This object can include any properties supported by that question. 

- `fit`: `Function`             
Specifies one or multiple conditions under which the property editor applies. Returns `true` if the editor can be used for the current property or `false` otherwise. In this demo, a custom editor applies when the property's `type` is `"shorttext"`.

To implement a custom editor, define an object with the `getJSON` and `fit` functions and register it in `PropertyGridEditorCollection`. The custom editor will be used for the properties that satisfy the `fit` conditions. Refer to the Code tab for a code example.

## Files

### `public/index.html`

```html
<div id="app" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0;"></div>
```

### `src/App.vue`

```html
<template>
    <SurveyCreatorComponent :model="creator" />
</template>
<script setup lang="ts">
    import { SurveyCreatorModel } from "survey-creator-core";
    import { SurveyCreatorComponent } from "survey-creator-vue";
    import { Serializer } from "survey-core";
    import { PropertyGridEditorCollection } from "survey-creator-core";
    import "survey-core/survey.i18n";
    import "survey-creator-core/survey-creator-core.i18n";
    import "survey-core/survey-core.css";
    import "survey-creator-core/survey-creator-core.css";
    import "./index.css";
    import SurveyTheme from "survey-core/themes";
    import { registerCreatorTheme } from "survey-creator-core";

    registerCreatorTheme(SurveyTheme); // Add predefined Survey Creator UI themes

    PropertyGridEditorCollection.register({
        // Use this editor for properties with `type: "shorttext"`
        fit: (prop) => {
            return prop.type === "shorttext";
        },
        // Return a question JSON configuration for the property editor
        // (a single-line input editor that is limited to 15 characters)
        getJSON: () => {
            return { type: "text", maxLength: 15 };
        }
    });
    
    // Add a custom property that uses the "shorttext" editor
    Serializer.addProperty("question", {
        name: "shortname",
        displayName: "Short name",
        type: "shorttext",
        category: "general",
        visibleIndex: 3
    });
    
    // Change the editor for the built-in `name` property
    Serializer.getProperty("question", "name").type = "shorttext";
    const creator = new SurveyCreatorModel();
    creator.JSON = {
      "elements": [
        {
          "type": "text",
          "name": "question1"  
        }
      ]
    }
    
    setTimeout(() => {
      creator.showSidebar = true;
      creator.selectElement(creator.survey.getQuestionByName("question1"), "shortname" )
    }, 10);
</script>
```

### `src/index.css`

```css
/* You can add your custom CSS here. */
```

### `src/main.ts`

```ts
import { createApp } from "vue";
import App from "./App.vue";

const app = createApp(App);
app.mount("#app");
```

### `src/shims-vue.d.ts`

```ts
/* eslint-disable */
declare module "*.vue" {
    import type { DefineComponent } from "vue"
    const component: DefineComponent<{}, {}, any>
    export default component
}
```

### `.eslintrc.js`

```js
module.exports = {
    root: true,
    env: {
        node: true
    },
    extends: [
        "plugin:vue/vue3-essential",
        "eslint:recommended",
        "@vue/typescript/recommended",
        "@vue/prettier",
        "@vue/prettier/@typescript-eslint"
    ],
    parserOptions: {
        ecmaVersion: 2020
    },
    rules: {
        "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
        "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
    },
    overrides: [
        {
            files: [
                "**/__tests__/*.{j,t}s?(x)",
                "**/tests/unit/**/*.spec.{j,t}s?(x)"
            ],
            env: {
                jest: true
            }
        }
    ]
};
```

### `babel.config.js`

```js
module.exports = {
  presets: ["@vue/cli-plugin-babel/preset"]
};
```

### `package.json`

```json
{
  "name": "surveyjs-library-vue3",
  "version": "0.1.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "core-js": "^3.6.5",
    "tslib": "2.6.1",
    "vue": "^3.4.1",
    "survey-core": "latest",
    "survey-vue3-ui": "latest",
    "survey-creator-core": "latest",
    "survey-creator-vue": "latest",
    "vue-router": "^4.0.0-0",
    "vuex": "^4.0.0-0"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^2.33.0",
    "@typescript-eslint/parser": "^2.33.0",
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-plugin-pwa": "~4.5.0",
    "@vue/cli-plugin-router": "~4.5.0",
    "@vue/cli-plugin-typescript": "~4.5.0",
    "@vue/cli-plugin-vuex": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "@vue/compiler-sfc": "^3.0.0",
    "@vue/eslint-config-prettier": "^6.0.0",
    "@vue/eslint-config-typescript": "^5.0.2",
    "@vue/test-utils": "^2.0.0-0",
    "eslint": "^6.7.2",
    "eslint-plugin-prettier": "^3.1.3",
    "eslint-plugin-vue": "^7.0.0-0",
    "node-sass": "^4.12.0",
    "prettier": "^1.19.1",
    "sass-loader": "^8.0.2",
    "typescript": "~3.9.3"
  }
}
```

### `tsconfig.json`

```json
{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "strict": true,
    "jsx": "preserve",
    "importHelpers": true,
    "moduleResolution": "node",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "sourceMap": true,
    "baseUrl": ".",
    "types": [
      "webpack-env",
      "jest"
    ],
    "paths": {
      "@/*": [
        "src/*"
      ]
    },
    "lib": [
      "esnext",
      "dom",
      "dom.iterable",
      "scripthost"
    ]
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "tests/**/*.ts",
    "tests/**/*.tsx"
  ],
  "exclude": [
    "node_modules"
  ]
}
```

## Other Frameworks

- [Angular](https://surveyjs.io/survey-creator/examples/customize-property-editors/angular.md)
- [React](https://surveyjs.io/survey-creator/examples/customize-property-editors/reactjs.md)
- [jQuery](https://surveyjs.io/survey-creator/examples/customize-property-editors/jquery.md)
- [Vanilla JS](https://surveyjs.io/survey-creator/examples/customize-property-editors/vanillajs.md)