{"record":{"id":"e17577ab3fd56934","repo":"Semantic-Org/Semantic-UI","slug":"the-overlay-setting-is-no-longer-supported-use-an","errorCode":null,"errorMessage":"The overlay setting is no longer supported, use animation: overlay","messagePattern":"The overlay setting is no longer supported, use animation: overlay","errorType":"console","errorClass":null,"httpStatus":null,"severity":"warning","filePath":"src/definitions/modules/sidebar.js","lineNumber":1026,"sourceCode":"\n  selector: {\n    fixed   : '.fixed',\n    omitted : 'script, link, style, .ui.modal, .ui.dimmer, .ui.nag, .ui.fixed',\n    pusher  : '.pusher',\n    sidebar : '.ui.sidebar'\n  },\n\n  regExp: {\n    ios          : /(iPad|iPhone|iPod)/g,\n    mobileChrome : /(CriOS)/g,\n    mobile       : /Mobile|iP(hone|od|ad)|Android|BlackBerry|IEMobile|Kindle|NetFront|Silk-Accelerated|(hpw|web)OS|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dolfin|Dolphin|Skyfire|Zune/g\n  },\n\n  error   : {\n    method       : 'The method you called is not defined.',\n    pusher       : 'Had to add pusher element. For optimal performance make sure body content is inside a pusher element',\n    movedSidebar : 'Had to move sidebar. For optimal performance make sure sidebar and pusher are direct children of your body tag',\n    overlay      : 'The overlay setting is no longer supported, use animation: overlay',\n    notFound     : 'There were no elements that matched the specified selector'\n  }\n\n};\n\n\n})( jQuery, window, document );\n","sourceCodeStart":1008,"sourceCodeEnd":1034,"githubUrl":"https://github.com/Semantic-Org/Semantic-UI/blob/597843ab84d565cccfd8fd7719416350ae73e734/src/definitions/modules/sidebar.js#L1008-L1034","documentation":"Emitted by Sidebar's show() (sidebar.js:372-373) when settings.overlay is truthy — the overlay setting was deprecated in favor of animation/transition:'overlay'. Sidebar coerces it (sets settings.transition='overlay') so the overlay animation still runs, then logs this deprecation warning. It is a console.error (sidebar.js:818), not thrown.","triggerScenarios":"$('.sidebar').sidebar({ overlay: true }).sidebar('show') — the truthy settings.overlay trips the deprecation branch at sidebar.js:372.","commonSituations":"Copying old config/examples that used overlay:true, upgrading from an older Semantic UI version where overlay was a first-class setting.","solutions":["Replace overlay:true with transition:'overlay' (the documented form).","Update to the current Semantic UI docs and remove any legacy overlay config.","Set silent:true only if you must keep the deprecated setting temporarily."],"exampleFix":"// before\n$('.sidebar').sidebar({ overlay: true }).sidebar('show');\n// after\n$('.sidebar').sidebar({ transition: 'overlay' }).sidebar('show');","handlingStrategy":"validation","validationCode":"// Reject deprecated config early and migrate to the supported form.\nfunction safeSidebar($el, opts){\n  opts = opts || {};\n  if (opts.overlay) {\n    console.warn('sidebar overlay:true is deprecated; use transition:\\'overlay\\'.');\n    opts.transition = 'overlay';\n    delete opts.overlay;\n  }\n  return $el.sidebar(opts);\n}","typeGuard":null,"tryCatchPattern":null,"preventionTips":["Use transition:'overlay' instead of the deprecated overlay:true.","Audit old config/examples when upgrading Semantic UI versions.","Run a startup lint pass that warns on any deprecated settings keys."],"tags":["sidebar","deprecated","migration"],"backgroundTag":null,"analyzedSha":"597843ab84d565cccfd8fd7719416350ae73e734","analyzedAt":"2026-08-13T01:44:23.827Z","schemaVersion":2},"datasetVersion":"2026-08-13T04:17:16.726Z"}