{"id":39487538,"url":"https://github.com/vtex-apps/admin-pages","last_synced_at":"2026-01-18T05:28:37.310Z","repository":{"id":37847964,"uuid":"120042060","full_name":"vtex-apps/admin-pages","owner":"vtex-apps","description":"The VTEX Pages CMS Admin","archived":false,"fork":false,"pushed_at":"2025-11-19T19:55:58.000Z","size":6489,"stargazers_count":17,"open_issues_count":33,"forks_count":13,"subscribers_count":45,"default_branch":"master","last_synced_at":"2025-11-19T21:18:53.366Z","etag":null,"topics":["hacktoberfest","srv-cms","vtex-io","xp-developer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex-apps.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-02-02T23:24:21.000Z","updated_at":"2025-11-19T19:56:01.000Z","dependencies_parsed_at":"2023-12-20T20:27:11.725Z","dependency_job_id":"bb4cd47e-8371-459a-ad97-8ced46d42d7e","html_url":"https://github.com/vtex-apps/admin-pages","commit_stats":null,"previous_names":[],"tags_count":339,"template":false,"template_full_name":null,"purl":"pkg:github/vtex-apps/admin-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fadmin-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fadmin-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fadmin-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fadmin-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex-apps","download_url":"https://codeload.github.com/vtex-apps/admin-pages/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fadmin-pages/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28530817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","srv-cms","vtex-io","xp-developer"],"created_at":"2026-01-18T05:28:36.821Z","updated_at":"2026-01-18T05:28:37.305Z","avatar_url":"https://github.com/vtex-apps.png","language":"TypeScript","readme":"# VTEX Pages Admin\n\nThe Pages Admin is a platform to dynamically edit a VTEX Store, making it possible to select editable components and change its configurations adding or removing content in a straightforward way.\n\n## Continuous Integrations\n\n### Travis CI\n\n[![Build Status](https://travis-ci.org/vtex-apps/pages-editor.svg?branch=master)](https://travis-ci.org/vtex-apps/pages-editor)\n\n## How to make your Component editable\n\nThe editor supports two ways of defining an editable component, thought a static schema structure or a dynamic function, that receives data and create the schema to be displayed.\n\n### Static Schema\n\nAdd to your component an `schema` constant, a JSON object that with the following structure:\n\n```javascript\nconst schema = {\n  type: 'object',\n  title: 'The component title',\n  properties: {\n    property1: {\n      type: 'string'\n      title: 'Title of the property'\n    },\n    ...{n* properties}\n  }\n}\n```\n\nThe property type can be: `String`, `Object` or `Number`, if `Object` it will have the same structure as the parent properties.\n\n### Dynamic Schema\n\nAdd to your component a function `getSchema`, that will have the logic to dynamically create the schema need to build your component structure. The Page Editor will call that function each time that the page form has a change to its state, which enables to add and remove fields from the schema, like the example below.\n\n```javascript\nimport { range, map, clone, indexBy, prop } from 'ramda'\n\nconst bannerStructure = {\n  type: 'object',\n  title: 'banner',\n  properties: {\n    image: {\n      type: 'string',\n      title: 'Banner image',\n    },\n    page: {\n      type: 'string',\n      title: 'Banner link',\n    },\n    targetParams: {\n      type: 'object',\n      title: 'Banner target params',\n      properties: {\n        params: {\n          type: 'string',\n          title: 'Params',\n        },\n      },\n    },\n  },\n}\n\nstatic getSchema = ({numberOfBanners}) =\u003e {\n  // Do a for loop replicating the banner structure, to create n* banners\n  const getRepeatedProperties = (repetition) =\u003e indexBy(prop('title'), map((index) =\u003e {\n    const property = clone(bannerStructure)\n    property.title = `${property.title}${index}`\n    return property\n  }, range(1, repetition+1)))\n\n  // Call's the function if the numberOfBanners its passed\n  const generatedSchema = numberOfBanners \u0026\u0026 getRepeatedProperties(numberOfBanners)\n\n  /**\n  * Returns a schema embedding the generated properties and the static property needed\n  * to type the number of banners wanted.\n  */\n  return {\n    type: 'object',\n    properties: {\n      numberOfBanners: {\n        type: 'number',\n        title: 'Number of banners'\n      },\n      ...generatedSchema\n    }\n  }\n}\n```\n\n## Custom Content Pages\n\nSee [docs](https://github.com/vtex-apps/admin-pages/blob/master/docs/CONTENT_PAGE.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fadmin-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex-apps%2Fadmin-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fadmin-pages/lists"}