From 81b982ac204dea738d7a0e76cdfb1967eddfaf84 Mon Sep 17 00:00:00 2001 From: Kate Higa Date: Fri, 8 Apr 2022 12:57:42 -0700 Subject: [PATCH] feat: add accDescription along with test page --- demos/journey.html | 45 +++++++++++++++++++ src/diagrams/user-journey/journeyDb.js | 20 +++++++-- src/diagrams/user-journey/journeyRenderer.js | 4 ++ .../user-journey/parser/journey.jison | 2 + 4 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 demos/journey.html diff --git a/demos/journey.html b/demos/journey.html new file mode 100644 index 000000000..177d956ba --- /dev/null +++ b/demos/journey.html @@ -0,0 +1,45 @@ + + + + + + + Mermaid Quick Test Page + + + + + +
+ journey + title My day + accDescription A user journey diagram of a typical day in my life + section Go to work + Make tea: 5: Me + Go upstairs: 3: Me + Do work: 1: Me, Cat + section Go home + Go downstairs: 5: Me + Sit down: 5: Me +
+ + + + + + + \ No newline at end of file diff --git a/src/diagrams/user-journey/journeyDb.js b/src/diagrams/user-journey/journeyDb.js index 0452bd4a8..b45561b95 100644 --- a/src/diagrams/user-journey/journeyDb.js +++ b/src/diagrams/user-journey/journeyDb.js @@ -1,7 +1,11 @@ import mermaidAPI from '../../mermaidAPI'; import * as configApi from '../../config'; +import common from '../common/common'; + +const sanitizeText = (txt) => common.sanitizeText(txt, configApi.getConfig()); let title = ''; +let description = ''; let currentSection = ''; const sections = []; @@ -20,14 +24,22 @@ export const clear = function () { rawTasks.length = 0; }; -export const setTitle = function (txt) { - title = txt; +const setTitle = function (txt) { + title = sanitizeText(txt); }; -export const getTitle = function () { +const getTitle = function () { return title; }; +const setAccDescription = function (txt) { + description = sanitizeText(txt); +}; + +const getAccDescription = function () { + return description; +}; + export const addSection = function (txt) { currentSection = txt; sections.push(txt); @@ -123,6 +135,8 @@ export default { clear, setTitle, getTitle, + setAccDescription, + getAccDescription, addSection, getSections, getTasks, diff --git a/src/diagrams/user-journey/journeyRenderer.js b/src/diagrams/user-journey/journeyRenderer.js index 7ce2caa68..612a89123 100644 --- a/src/diagrams/user-journey/journeyRenderer.js +++ b/src/diagrams/user-journey/journeyRenderer.js @@ -4,6 +4,7 @@ import journeyDb from './journeyDb'; import svgDraw from './svgDraw'; import { getConfig } from '../../config'; import { configureSvgSize } from '../../utils'; +import addSVGAccessibilityFields from '../../accessibility'; parser.yy = journeyDb; @@ -100,6 +101,7 @@ export const draw = function (text, id) { .attr('font-weight', 'bold') .attr('y', 25); } + const height = box.stopy - box.starty + 2 * conf.diagramMarginY; const width = LEFT_MARGIN + box.stopx + 2 * conf.diagramMarginX; @@ -120,6 +122,8 @@ export const draw = function (text, id) { diagram.attr('viewBox', `${box.startx} -25 ${width} ${height + extraVertForTitle}`); diagram.attr('preserveAspectRatio', 'xMinYMin meet'); diagram.attr('height', height + extraVertForTitle + 25); + + addSVGAccessibilityFields(parser.yy, diagram, id); }; export const bounds = { diff --git a/src/diagrams/user-journey/parser/journey.jison b/src/diagrams/user-journey/parser/journey.jison index e4282ea51..37d493d3e 100644 --- a/src/diagrams/user-journey/parser/journey.jison +++ b/src/diagrams/user-journey/parser/journey.jison @@ -25,6 +25,7 @@ "journey" return 'journey'; "title"\s[^#\n;]+ return 'title'; +"accDescription"\s[^#\n;]+ return 'accDescription'; "section"\s[^#:\n;]+ return 'section'; [^#:\n;]+ return 'taskName'; ":"[^#\n;]+ return 'taskData'; @@ -64,6 +65,7 @@ directive statement : title {yy.setTitle($1.substr(6));$$=$1.substr(6);} + | accDescription {yy.setAccDescription($1.substring(15));$$=$1.substring(15);} | section {yy.addSection($1.substr(8));$$=$1.substr(8);} | taskName taskData {yy.addTask($1, $2);$$='task';} | directive