discourse/app/assets/javascripts/admin/addon/templates/dashboard.hbs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

57 lines
1.5 KiB
Handlebars
Raw Normal View History

DEV: Update default tagName and connectorTagName for plugin outlets (#13685) This commit should be a no-op for all existing core outlets. Outlets which are introduced by themes/plugins may see a change in behavior, and should follow the steps below if they want to maintain their previous behavior. `tagName="" connectorTagName=""` is almost always the correct choice for plugin outlets. 40eba8cd introduced a `noTags=true` shortcut which achieved this, and left a comment saying it should be the future default. This commit does exactly that. To avoid any breaking changes for plugins, all existing plugin outlets have been reviewed and adjusted by following this logic: 1) If `noTags=true`, remove the `noTags` parameter, and do not complete any further steps 2) If `tagName` is not specified, set `tagName="span"` (the previous default) 3) If `connectorTagName` is not specified, set `selectorTagName="div"` (the previous default) 4) If `tagName=""`, remove it 5) If `connectorTagName=""`, remove it The updates were accomplished with the help of a ruby script: ```ruby def removeAttr(tag, attribute) tag = tag.sub /\s#{attribute}="?\w*"? /, " " tag = tag.sub /\s#{attribute}="?\w*"?}}/, "}}" tag = tag.sub /^\s*#{attribute}="?\w*"?\n/, "" tag end files = Dir.glob("app/assets/javascripts/**/*.hbs") puts "Checking #{files.count} files..." files.each do |f| content = File.read(f) count = 0 edits = 0 content.gsub!(/{{\s*plugin-outlet.*?}}/m) do |match| count += 1 result = match noTags = result.include?("noTags=true") tagName = result[/tagName="(\w*)"/, 1] connectorTagName = result[/connectorTagName="(\w*)"/, 1] if noTags result = removeAttr(result, "noTags") else if connectorTagName == "" result = removeAttr(result, "connectorTagName") elsif connectorTagName.nil? result = result.sub(/name="[\w-]+"/) { |m| "#{m} connectorTagName=\"div\"" } end if tagName == "" result = removeAttr(result, "tagName") elsif tagName.nil? result = result.sub(/name="[\w-]+"/) { |m| "#{m} tagName=\"span\"" } end end edits += 1 if match != result result end puts "#{count} outlets, #{edits} edited -> #{f}" File.write(f, content) end ```
2022-01-06 15:38:17 -05:00
{{plugin-outlet name="admin-dashboard-top" tagName="span" connectorTagName="div"}}
2019-04-01 06:39:49 -04:00
{{#if showVersionChecks}}
<div class="section-top">
<div class="version-checks">
{{version-checks versionCheck=versionCheck tagName=""}}
</div>
</div>
2019-04-01 06:39:49 -04:00
{{/if}}
{{dashboard-problems
loadingProblems=loadingProblems
foundProblems=foundProblems
lowPriorityProblems=lowPriorityProblems
highPriorityProblems=highPriorityProblems
problemsTimestamp=problemsTimestamp
refreshProblems=(action "refreshProblems")
}}
2019-04-01 06:39:49 -04:00
<ul class="navigation">
<li class="navigation-item general">
{{#link-to "admin.dashboard.general" class="navigation-link"}}
{{i18n "admin.dashboard.general_tab"}}
{{/link-to}}
</li>
{{#if isModerationTabVisible}}
<li class="navigation-item moderation">
{{#link-to "admin.dashboardModeration" class="navigation-link"}}
{{i18n "admin.dashboard.moderation_tab"}}
{{/link-to}}
</li>
{{/if}}
{{#if isSecurityTabVisible}}
<li class="navigation-item security">
{{#link-to "admin.dashboardSecurity" class="navigation-link"}}
{{i18n "admin.dashboard.security_tab"}}
{{/link-to}}
</li>
{{/if}}
{{#if isReportsTabVisible}}
<li class="navigation-item reports">
{{#link-to "admin.dashboardReports" class="navigation-link"}}
{{i18n "admin.dashboard.reports_tab"}}
{{/link-to}}
</li>
{{/if}}
2019-04-01 06:39:49 -04:00
</ul>
{{outlet}}
{{dashboard-new-features tagName="div"}}
DEV: Update default tagName and connectorTagName for plugin outlets (#13685) This commit should be a no-op for all existing core outlets. Outlets which are introduced by themes/plugins may see a change in behavior, and should follow the steps below if they want to maintain their previous behavior. `tagName="" connectorTagName=""` is almost always the correct choice for plugin outlets. 40eba8cd introduced a `noTags=true` shortcut which achieved this, and left a comment saying it should be the future default. This commit does exactly that. To avoid any breaking changes for plugins, all existing plugin outlets have been reviewed and adjusted by following this logic: 1) If `noTags=true`, remove the `noTags` parameter, and do not complete any further steps 2) If `tagName` is not specified, set `tagName="span"` (the previous default) 3) If `connectorTagName` is not specified, set `selectorTagName="div"` (the previous default) 4) If `tagName=""`, remove it 5) If `connectorTagName=""`, remove it The updates were accomplished with the help of a ruby script: ```ruby def removeAttr(tag, attribute) tag = tag.sub /\s#{attribute}="?\w*"? /, " " tag = tag.sub /\s#{attribute}="?\w*"?}}/, "}}" tag = tag.sub /^\s*#{attribute}="?\w*"?\n/, "" tag end files = Dir.glob("app/assets/javascripts/**/*.hbs") puts "Checking #{files.count} files..." files.each do |f| content = File.read(f) count = 0 edits = 0 content.gsub!(/{{\s*plugin-outlet.*?}}/m) do |match| count += 1 result = match noTags = result.include?("noTags=true") tagName = result[/tagName="(\w*)"/, 1] connectorTagName = result[/connectorTagName="(\w*)"/, 1] if noTags result = removeAttr(result, "noTags") else if connectorTagName == "" result = removeAttr(result, "connectorTagName") elsif connectorTagName.nil? result = result.sub(/name="[\w-]+"/) { |m| "#{m} connectorTagName=\"div\"" } end if tagName == "" result = removeAttr(result, "tagName") elsif tagName.nil? result = result.sub(/name="[\w-]+"/) { |m| "#{m} tagName=\"span\"" } end end edits += 1 if match != result result end puts "#{count} outlets, #{edits} edited -> #{f}" File.write(f, content) end ```
2022-01-06 15:38:17 -05:00
{{plugin-outlet name="admin-dashboard-bottom" tagName="span" connectorTagName="div"}}