├── .editorconfig ├── .eslintignore ├── .eslintrc ├── .gitignore ├── .npmignore ├── .prettierignore ├── .prettierrc ├── LICENSE ├── README.md ├── package-lock.json ├── package.config.ts ├── package.json ├── sanity.json ├── src ├── SlugInput.tsx ├── demo.gif ├── index.ts ├── usePrefixLogic.ts └── useSlugContext.ts ├── tsconfig.json └── v2-incompatible.js /.editorconfig: -------------------------------------------------------------------------------- 1 | ; editorconfig.org 2 | root = true 3 | charset= utf8 4 | 5 | [*] 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | indent_style = space 10 | indent_size = 2 11 | 12 | [*.md] 13 | trim_trailing_whitespace = false 14 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | .eslintrc.js 2 | commitlint.config.js 3 | lib 4 | lint-staged.config.js 5 | package.config.ts 6 | *.js -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "env": { 4 | "node": true, 5 | "browser": true 6 | }, 7 | "extends": [ 8 | "sanity", 9 | "sanity/typescript", 10 | "sanity/react", 11 | "plugin:react-hooks/recommended", 12 | "plugin:prettier/recommended" 13 | ] 14 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | 39 | # macOS finder cache file 40 | .DS_Store 41 | 42 | # VS Code settings 43 | .vscode 44 | 45 | # IntelliJ 46 | .idea 47 | *.iml 48 | 49 | # Cache 50 | .cache 51 | 52 | # Yalc 53 | .yalc 54 | yalc.lock 55 | 56 | ##npm package zips 57 | *.tgz 58 | 59 | # Compiled plugin 60 | lib 61 | 62 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .git 2 | src/* 3 | !src/previewTypes.d.ts 4 | clearLib.js 5 | .prettierignore 6 | .prettierrc 7 | tsconfig.json -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | lib -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": false, 3 | "singleQuote": true, 4 | "trailingComma": "all", 5 | "tabWidth": 2, 6 | "printWidth": 100 7 | } 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sanity-plugin-prefixed-slug 2 | 3 | Editor friendly slug fields for your Sanity.io studio. Prefixed URLs and auto-slugifying values. 4 | 5 | ![Screenshot of the plugin in action](src/demo.gif) 6 | 7 | ## Installation 8 | 9 | Start by enabling it in your Sanity V3 studio: 10 | 11 | ```bash 12 | yarn add sanity-plugin-prefixed-slug 13 | # or npm 14 | npm i sanity-plugin-prefixed-slug 15 | ``` 16 | 17 | 🚨 If you're using Sanity V2, use the `^1.0.0` releases of this plugin. 18 | 19 | Then, use the custom input component in your `slug` field(s): 20 | 21 | ```js 22 | import { SlugInput } from 'sanity-plugin-prefixed-slug' 23 | 24 | export default { 25 | name: 'testing-slugs', 26 | type: 'document', 27 | fields: [ 28 | { 29 | name: 'slug_regular_custom_input', 30 | type: 'slug', 31 | // Add the custom input to the `component` object of your field 32 | components: { 33 | input: SlugInput, 34 | }, 35 | options: { 36 | source: 'title', 37 | urlPrefix: 'https://site.url', 38 | // Use isUnique/maxLength just like you would w/ the regular slug field 39 | isUnique: MyCustomIsUniqueFunction, 40 | maxLength: 30, 41 | // If you want to save the full URL in the slug object, set storeFullUrl to `true` 42 | // Example storage: { _type: "slug", current: "my-slug", fullUrl: "https://site.com/my-slug" } 43 | storeFullUrl: true, 44 | }, 45 | }, 46 | { 47 | // If you want to customize how slugs are formatted 48 | name: 'slug_custom_format', 49 | type: 'slug', 50 | components: { 51 | input: SlugInput, 52 | }, 53 | options: { 54 | urlPrefix: 'https://site.url', 55 | slugify: (slugString) => slugString.toLowerCase(), 56 | // You can also avoid slugifying entirely by returning the full value: 57 | slugify: (slugString) => slugString, 58 | }, 59 | }, 60 | { 61 | // If you want to provide a custom path based on the current document: 62 | name: 'slug_function_path', 63 | type: 'slug', 64 | components: { 65 | input: SlugInput, 66 | }, 67 | options: { 68 | urlPrefix: (document) => `https://site.url/${document.lang}`, 69 | // It could even be a promise! 🛑 Be careful: this will be triggered on every document change. 70 | urlPrefix: async (document) => { 71 | const subPath = await getDocumentSubPath(document) // ficticious asynchronous method 72 | return `https://site.url/${subPath}` 73 | }, 74 | }, 75 | }, 76 | ], 77 | } 78 | ``` 79 | 80 | 💡 This plugin used to be called `sanity-plugin-better-slug`. As that was pretentious and unclear, I've made the switch to `prefixed-slug`. 81 | 82 | Upgrading from sanity-plugin-better-slug? Rename your `options.basePath` to `options.urlPrefix`. 83 | -------------------------------------------------------------------------------- /package.config.ts: -------------------------------------------------------------------------------- 1 | import {defineConfig} from '@sanity/pkg-utils' 2 | 3 | export default defineConfig({ 4 | dist: 'lib', 5 | minify: true, 6 | legacyExports: true, 7 | // Remove this block to enable strict export validation 8 | extract: { 9 | rules: { 10 | 'ae-forgotten-export': 'off', 11 | 'ae-incompatible-release-tags': 'off', 12 | 'ae-internal-missing-underscore': 'off', 13 | 'ae-missing-release-tag': 'off', 14 | }, 15 | }, 16 | }) 17 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sanity-plugin-prefixed-slug", 3 | "version": "2.0.0", 4 | "description": "Editor friendly slug fields for your Sanity.io studio", 5 | "keywords": [ 6 | "sanity.io", 7 | "sanity", 8 | "slug", 9 | "sanity-plugin" 10 | ], 11 | "homepage": "https://github.com/hdoro/sanity-plugin-prefixed-slug#readme", 12 | "bugs": { 13 | "url": "https://github.com/hdoro/sanity-plugin-prefixed-slug/issues" 14 | }, 15 | "repository": { 16 | "type": "git", 17 | "url": "https://github.com/hdoro/sanity-plugin-prefixed-slug.git" 18 | }, 19 | "license": "Apache-2.0", 20 | "author": "Henrique Doro ", 21 | "type": "commonjs", 22 | "exports": { 23 | ".": { 24 | "types": "./lib/src/index.d.ts", 25 | "source": "./src/index.ts", 26 | "import": "./lib/index.esm.js", 27 | "require": "./lib/index.js", 28 | "default": "./lib/index.esm.js" 29 | }, 30 | "./package.json": "./package.json" 31 | }, 32 | "main": "./lib/index.js", 33 | "module": "./lib/index.esm.js", 34 | "source": "./src/index.ts", 35 | "types": "./lib/src/index.d.ts", 36 | "files": [ 37 | "src", 38 | "lib", 39 | "v2-incompatible.js", 40 | "sanity.json" 41 | ], 42 | "scripts": { 43 | "prebuild": "npm run clean && plugin-kit verify-package --silent && pkg-utils", 44 | "build": "pkg-utils build", 45 | "clean": "rimraf lib", 46 | "clear-lib": "node clearLib.js", 47 | "dev": "tsc -w", 48 | "format": "prettier --write .", 49 | "link-watch": "plugin-kit link-watch", 50 | "lint": "eslint .", 51 | "prepublishOnly": "npm run build", 52 | "prepublish": "npm run build", 53 | "watch": "pkg-utils watch" 54 | }, 55 | "eslintConfig": { 56 | "parser": "sanipack/babel/eslint-parser", 57 | "extends": [ 58 | "sanity", 59 | "sanity/react", 60 | "prettier", 61 | "prettier/react" 62 | ] 63 | }, 64 | "dependencies": { 65 | "@sanity/incompatible-plugin": "^1.0.4", 66 | "@sanity/ui": "^1.0.0", 67 | "speakingurl": "^14.0.1" 68 | }, 69 | "devDependencies": { 70 | "@sanity/pkg-utils": "^2.0.0", 71 | "@sanity/plugin-kit": "^2.2.0", 72 | "@types/react": "^18", 73 | "@types/react-dom": "^18", 74 | "@types/speakingurl": "^13.0.3", 75 | "@types/styled-components": "^5.1.25", 76 | "@typescript-eslint/eslint-plugin": "^5.47.0", 77 | "@typescript-eslint/parser": "^5.47.0", 78 | "eslint": "^8.30.0", 79 | "eslint-config-prettier": "^8.5.0", 80 | "eslint-config-sanity": "^6.0.0", 81 | "eslint-plugin-prettier": "^4.2.1", 82 | "eslint-plugin-react": "^7.31.11", 83 | "eslint-plugin-react-hooks": "^4.6.0", 84 | "prettier": "^2.8.1", 85 | "prettier-plugin-packagejson": "^2.3.0", 86 | "react": "^18", 87 | "rimraf": "^3.0.2", 88 | "sanity": "^3.0.0", 89 | "typescript": "^4.9.4" 90 | }, 91 | "peerDependencies": { 92 | "react": "^18", 93 | "sanity": "^3.0.0", 94 | "styled-components": ">= 5.0.0" 95 | }, 96 | "engines": { 97 | "node": ">=14" 98 | }, 99 | "sanityExchangeUrl": "https://www.sanity.io/plugins/prefixed-slug" 100 | } 101 | -------------------------------------------------------------------------------- /sanity.json: -------------------------------------------------------------------------------- 1 | { 2 | "parts": [ 3 | { 4 | "implements": "part:@sanity/base/sanity-root", 5 | "path": "./v2-incompatible.js" 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /src/SlugInput.tsx: -------------------------------------------------------------------------------- 1 | import { Box, Button, Card, Code, Flex, Text, TextInput, Tooltip } from '@sanity/ui' 2 | import React, { useCallback } from 'react' 3 | import { SlugInputProps } from 'sanity' 4 | import styled from 'styled-components' 5 | import { usePrefixLogic } from './usePrefixLogic' 6 | 7 | const UrlPrefix = styled(Card)` 8 | flex: 0 1 min-content; 9 | 10 | pre { 11 | padding: 1em 0; 12 | } 13 | 14 | pre, 15 | code { 16 | overflow: hidden; 17 | white-space: nowrap; 18 | max-width: 30ch; 19 | text-overflow: ellipsis; 20 | } 21 | 22 | // When no generate button is available, make it bigger 23 | &[data-no-generate='true'] { 24 | pre, 25 | code { 26 | max-width: 35ch; 27 | } 28 | } 29 | ` 30 | 31 | /** 32 | * Custom slug component for better UX & safer slugs: 33 | * - shows the final URL for the relative address (adds the BASE.PATH/ at the start) 34 | * - removes special characters and startin/trailing slashes 35 | */ 36 | const PrefixedSlugInput = (props: SlugInputProps) => { 37 | const { value, schemaType } = props 38 | const { prefix, generateSlug, updateValue, formatSlug } = usePrefixLogic(props) 39 | 40 | const onChange = useCallback( 41 | (event: React.FormEvent) => updateValue(event.currentTarget.value), 42 | [updateValue], 43 | ) 44 | 45 | const onBlur = useCallback( 46 | (event: React.FocusEvent) => { 47 | formatSlug(event.currentTarget.value) 48 | props.elementProps.onBlur(event) 49 | }, 50 | // eslint-disable-next-line 51 | [formatSlug, props.elementProps.onBlur], 52 | ) 53 | 54 | return ( 55 | 56 | {prefix && ( 57 | 60 | {prefix} 61 | 62 | } 63 | > 64 | 65 | {prefix} 66 | 67 | 68 | )} 69 | 70 | 77 | 78 | {schemaType.options?.source && ( 79 |