@salesforcedevs/docs-components 0.3.11 → 0.3.14-banner-alpha1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/lwc.config.json +12 -3
  2. package/package.json +17 -7
  3. package/src/modules/README.md +41 -0
  4. package/src/modules/doc/amfReference/amfReference.css +5 -0
  5. package/src/modules/doc/amfReference/amfReference.html +47 -0
  6. package/src/modules/doc/amfReference/amfReference.ts +1361 -0
  7. package/src/modules/doc/amfReference/constants.ts +76 -0
  8. package/src/modules/doc/amfReference/types.ts +133 -0
  9. package/src/modules/doc/amfReference/utils.ts +669 -0
  10. package/src/modules/doc/amfTopic/amfTopic.css +1 -0
  11. package/src/modules/doc/amfTopic/amfTopic.html +3 -0
  12. package/src/modules/doc/amfTopic/amfTopic.ts +94 -0
  13. package/src/modules/doc/amfTopic/types.ts +54 -0
  14. package/src/modules/doc/amfTopic/utils.ts +130 -0
  15. package/src/modules/doc/breadcrumbItem/breadcrumbItem.css +51 -0
  16. package/src/modules/doc/breadcrumbItem/breadcrumbItem.html +5 -0
  17. package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts +64 -0
  18. package/src/modules/doc/breadcrumbs/breadcrumbs.css +27 -0
  19. package/src/modules/doc/breadcrumbs/breadcrumbs.html +60 -0
  20. package/src/modules/doc/breadcrumbs/breadcrumbs.ts +187 -0
  21. package/src/modules/doc/content/content.css +58 -102
  22. package/src/modules/doc/content/content.ts +261 -174
  23. package/src/modules/doc/contentCallout/contentCallout.css +7 -24
  24. package/src/modules/doc/contentCallout/contentCallout.html +4 -2
  25. package/src/modules/doc/contentCallout/contentCallout.ts +8 -2
  26. package/src/modules/doc/contentLayout/contentLayout.css +98 -0
  27. package/src/modules/doc/contentLayout/contentLayout.html +51 -0
  28. package/src/modules/doc/contentLayout/contentLayout.ts +322 -0
  29. package/src/modules/doc/header/header.css +103 -0
  30. package/src/modules/doc/header/header.html +160 -0
  31. package/src/modules/doc/header/header.ts +146 -0
  32. package/src/modules/doc/heading/heading.css +54 -0
  33. package/src/modules/doc/heading/heading.html +14 -0
  34. package/src/modules/doc/heading/heading.ts +65 -0
  35. package/src/modules/doc/headingAnchor/headingAnchor.css +33 -0
  36. package/src/modules/doc/headingAnchor/headingAnchor.html +19 -0
  37. package/src/modules/doc/headingAnchor/headingAnchor.ts +43 -0
  38. package/src/modules/doc/headingContent/headingContent.css +53 -0
  39. package/src/modules/doc/headingContent/headingContent.html +13 -0
  40. package/src/modules/doc/headingContent/headingContent.ts +30 -0
  41. package/src/modules/doc/phase/phase.css +55 -0
  42. package/src/modules/doc/phase/phase.html +28 -0
  43. package/src/modules/doc/phase/phase.ts +57 -0
  44. package/src/modules/doc/sprigSurvey/sprigSurvey.html +20 -0
  45. package/src/modules/doc/sprigSurvey/sprigSurvey.scoped.css +12 -0
  46. package/src/modules/doc/sprigSurvey/sprigSurvey.ts +16 -0
  47. package/src/modules/doc/toc/toc.html +3 -1
  48. package/src/modules/doc/toolbar/toolbar.ts +6 -6
  49. package/src/modules/doc/xmlContent/types.ts +114 -0
  50. package/src/modules/doc/xmlContent/utils.ts +161 -0
  51. package/src/modules/doc/xmlContent/xmlContent.css +32 -0
  52. package/src/modules/doc/xmlContent/xmlContent.html +40 -0
  53. package/src/modules/doc/xmlContent/xmlContent.ts +677 -0
  54. package/src/modules/docBaseElements/lightningElementWithState/lightningElementWithState.ts +93 -0
  55. package/src/modules/docHelpers/amfStyle/amfStyle.css +355 -0
  56. package/src/modules/docHelpers/phaseContentLayout/phaseContentLayout.css +39 -0
  57. package/src/modules/docHelpers/status/status.css +22 -0
  58. package/src/modules/docUtils/SearchSyncer/SearchSyncer.ts +85 -0
  59. package/LICENSE +0 -12
  60. package/src/modules/doc/container/__benchmarks__/container.benchmark.js +0 -43
  61. package/src/modules/doc/container/__mocks__/mockAvailableLanguages.js +0 -8
  62. package/src/modules/doc/container/__mocks__/mockAvailableVersions.js +0 -122
  63. package/src/modules/doc/container/__mocks__/mockContentFetchResponse.json +0 -5
  64. package/src/modules/doc/container/__mocks__/mockDocContent.js +0 -29
  65. package/src/modules/doc/container/__mocks__/mockNavigationFetchResponse.json +0 -4061
  66. package/src/modules/doc/container/__mocks__/mockPageReference.js +0 -8
  67. package/src/modules/doc/container/__mocks__/mockPdfUrl.js +0 -1
  68. package/src/modules/doc/container/__mocks__/mockSelectedLanguage.js +0 -8
  69. package/src/modules/doc/container/__mocks__/mockSelectedVersion.js +0 -8
  70. package/src/modules/doc/container/__mocks__/mockToc.js +0 -146
  71. package/src/modules/doc/container/__tests__/container.test.ts +0 -117
  72. package/src/modules/doc/container/container.css +0 -37
  73. package/src/modules/doc/container/container.html +0 -28
  74. package/src/modules/doc/container/container.stories.ts +0 -44
  75. package/src/modules/doc/container/container.ts +0 -367
  76. package/src/modules/doc/content/__tests__/content.test.ts +0 -99
  77. package/src/modules/doc/content/__tests__/mockDocContent.ts +0 -258
  78. package/src/modules/doc/content/__tests__/mockPageReference.ts +0 -8
  79. package/src/modules/doc/content/content.stories.ts +0 -82
  80. package/src/modules/doc/contentCallout/__tests__/contentCallout.test.ts +0 -80
  81. package/src/modules/doc/contentCallout/__tests__/mockProps.ts +0 -14
  82. package/src/modules/doc/contentCallout/contentCallout.stories.ts +0 -29
  83. package/src/modules/doc/contentMedia/__tests__/contentMedia.test.ts +0 -97
  84. package/src/modules/doc/contentMedia/contentMedia.stories.ts +0 -113
  85. package/src/modules/doc/landing/__tests__/landing.test.ts +0 -60
  86. package/src/modules/doc/landing/__tests__/mockFetch.json +0 -370
  87. package/src/modules/doc/landing/landing.css +0 -63
  88. package/src/modules/doc/landing/landing.html +0 -122
  89. package/src/modules/doc/landing/landing.stories.ts +0 -21
  90. package/src/modules/doc/landing/landing.ts +0 -222
  91. package/src/modules/doc/nav/__tests__/mockAvailableLanguages.ts +0 -8
  92. package/src/modules/doc/nav/__tests__/mockAvailableVersions.ts +0 -122
  93. package/src/modules/doc/nav/__tests__/mockPageReference.ts +0 -8
  94. package/src/modules/doc/nav/__tests__/mockPdfUrl.ts +0 -1
  95. package/src/modules/doc/nav/__tests__/mockSelectedLanguage.ts +0 -8
  96. package/src/modules/doc/nav/__tests__/mockSelectedVersion.ts +0 -8
  97. package/src/modules/doc/nav/__tests__/mockToc.ts +0 -146
  98. package/src/modules/doc/nav/__tests__/nav.test.ts +0 -58
  99. package/src/modules/doc/toc/__tests__/mockPageReference.ts +0 -8
  100. package/src/modules/doc/toc/__tests__/mockToc.ts +0 -146
  101. package/src/modules/doc/toc/__tests__/toc.test.ts +0 -29
  102. package/src/modules/doc/toolbar/__tests__/mockAvailableLanguages.ts +0 -8
  103. package/src/modules/doc/toolbar/__tests__/mockAvailableVersions.ts +0 -122
  104. package/src/modules/doc/toolbar/__tests__/mockPdfUrl.ts +0 -1
  105. package/src/modules/doc/toolbar/__tests__/mockSelectedLanguage.ts +0 -8
  106. package/src/modules/doc/toolbar/__tests__/mockSelectedVersion.ts +0 -8
  107. package/src/modules/doc/toolbar/__tests__/toolbar.test.ts +0 -44
@@ -1,122 +0,0 @@
1
- export default [
2
- {
3
- version_text: "Winter '21 (API version 50.0)",
4
- release_version: "50.0",
5
- doc_version: "228.0",
6
- version_url: "atlas.en-us.apexcode.meta"
7
- },
8
- {
9
- version_text: "Summer '20 (API version 49.0)",
10
- release_version: "49.0",
11
- doc_version: "226.0",
12
- version_url: "atlas.en-us.226.0.apexcode.meta"
13
- },
14
- {
15
- version_text: "Spring '20 (API version 48.0)",
16
- release_version: "48.0",
17
- doc_version: "224.0",
18
- version_url: "atlas.en-us.224.0.apexcode.meta"
19
- },
20
- {
21
- version_text: "Winter '20 (API version 47.0)",
22
- release_version: "47.0",
23
- doc_version: "222.0",
24
- version_url: "atlas.en-us.222.0.apexcode.meta"
25
- },
26
- {
27
- version_text: "Summer '19 (API version 46.0)",
28
- release_version: "46.0",
29
- doc_version: "220.0",
30
- version_url: "atlas.en-us.220.0.apexcode.meta"
31
- },
32
- {
33
- version_text: "Spring '19 (API version 45.0)",
34
- release_version: "45.0",
35
- doc_version: "218.0",
36
- version_url: "atlas.en-us.218.0.apexcode.meta"
37
- },
38
- {
39
- version_text: "Winter '19 (API version 44.0)",
40
- release_version: "44.0",
41
- doc_version: "216.0",
42
- version_url: "atlas.en-us.216.0.apexcode.meta"
43
- },
44
- {
45
- version_text: "Summer '18 (API version 43.0)",
46
- release_version: "43.0",
47
- doc_version: "214.0",
48
- version_url: "atlas.en-us.214.0.apexcode.meta"
49
- },
50
- {
51
- version_text: "Spring '18 (API version 42.0)",
52
- release_version: "42.0",
53
- doc_version: "212.0",
54
- version_url: "atlas.en-us.212.0.apexcode.meta"
55
- },
56
- {
57
- version_text: "Winter '18 (API version 41.0)",
58
- release_version: "41.0",
59
- doc_version: "210.0",
60
- version_url: "atlas.en-us.210.0.apexcode.meta"
61
- },
62
- {
63
- version_text: "Summer '17 (API version 40.0)",
64
- release_version: "40.0",
65
- doc_version: "208.0",
66
- version_url: "atlas.en-us.208.0.apexcode.meta"
67
- },
68
- {
69
- version_text: "Spring '17 (API version 39.0)",
70
- release_version: "39.0",
71
- doc_version: "206.0",
72
- version_url: "atlas.en-us.206.0.apexcode.meta"
73
- },
74
- {
75
- version_text: "Winter '17 (API version 38.0)",
76
- release_version: "38.0",
77
- doc_version: "204.0",
78
- version_url: "atlas.en-us.204.0.apexcode.meta"
79
- },
80
- {
81
- version_text: "Summer '16 (API version 37.0)",
82
- release_version: "37.0",
83
- doc_version: "202.0",
84
- version_url: "atlas.en-us.202.0.apexcode.meta"
85
- },
86
- {
87
- version_text: "Spring '16 (API version 36.0)",
88
- release_version: "36.0",
89
- doc_version: "200.0",
90
- version_url: "atlas.en-us.200.0.apexcode.meta"
91
- },
92
- {
93
- version_text: "Winter '16 (API version 35.0)",
94
- release_version: "35.0",
95
- doc_version: "198.0",
96
- version_url: "atlas.en-us.198.0.apexcode.meta"
97
- },
98
- {
99
- version_text: "Summer '15 (API version 34.0)",
100
- release_version: "34.0",
101
- doc_version: "196.0",
102
- version_url: "atlas.en-us.196.0.apexcode.meta"
103
- },
104
- {
105
- version_text: "Spring '15 (API version 33.0)",
106
- release_version: "33.0",
107
- doc_version: "194.0",
108
- version_url: "atlas.en-us.194.0.apexcode.meta"
109
- },
110
- {
111
- version_text: "Winter '15 (API version 32.0)",
112
- release_version: "32.0",
113
- doc_version: "192.0",
114
- version_url: "atlas.en-us.192.0.apexcode.meta"
115
- },
116
- {
117
- version_text: "Spring '14 (API version 30.0)",
118
- release_version: "30.0",
119
- doc_version: "188.0",
120
- version_url: "atlas.en-us.188.0.apexcode.meta"
121
- }
122
- ];
@@ -1,5 +0,0 @@
1
- {
2
- "id": "apex_dev_guide",
3
- "title": "Adding an Apex Class",
4
- "content": "<a name=\"apex_qs_class\"><!-- --></a><h1 class=\"helpHead1\"><span class=\"ph\" id=\"topic-title\"><a name=\"topic-title\"><!-- --></a>Adding an Apex Class</span></h1><div class=\"body taskbody\">\n<div class=\"shortdesc\">In this step, you add an Apex class that contains a method for updating the book\n price. This method is called by the trigger that you will be adding in the next\n step.</div>\n\n <div class=\"section prereq p\"><div class=\"p\">Prerequisites:<ul class=\"ul bulletList\">\n <li class=\"li\">A Salesforce account in a sandbox Professional,\n Enterprise, Performance, or Unlimited Edition org, or an account in a Developer\n org.</li>\n\n <li class=\"li\">\n<a class=\"xref\" href=\"atlas.en-us.apexcode.meta/apexcode/apex_qs_customobject.htm\" title=\"In this step, you create a custom object called Book with one custom field called Price.\">The Book\n custom object</a>.</li>\n\n </ul>\n</div></div>\n\n <ol class=\"ol steps enumList\">\n <li class=\"li step\">\n <span class=\"ph cmd\">From Setup, enter “Apex Classes” in the <span class=\"keyword parmname\">Quick Find</span> box,\n then select <strong class=\"ph uicontrol\">Apex Classes</strong> and click\n <strong class=\"ph uicontrol\">New</strong>.</span>\n </li>\n\n <li class=\"li step\">\n <span class=\"ph cmd\">In the class editor, enter this class definition:</span>\n <div class=\"itemgroup stepxmp\">\n <div class=\"codeSection apex_code\"><pre class=\"codeblock brush:apex\"><span class=\"keyword\">public</span> <span class=\"keyword\">class</span> MyHelloWorld {\n\n}</pre></div>\n\n </div>\n <div class=\"itemgroup info\">The previous code is the class definition to which you will be adding one\n method in the next step. Apex code is generally contained in <em class=\"ph i\">classes.</em>\n This class is defined as <samp class=\"codeph apex_code\"><span class=\"keyword\">public</span></samp>, which\n means the class is available to other Apex classes and triggers. For more\n information, see <a class=\"xref\" href=\"atlas.en-us.apexcode.meta/apexcode/apex_classes.htm\" title=\"Apex classes are modeled on their counterparts in Java. You’ll define, instantiate, and extend classes, and you’ll work with interfaces, Apex class versions, properties, and other related class concepts.\">Classes, Objects, and Interfaces</a>.</div>\n </li>\n\n <li class=\"li step\">\n <span class=\"ph cmd\">Add this method definition between the class opening and closing\n brackets.</span>\n <div class=\"itemgroup stepxmp\">\n <div class=\"codeSection apex_code\"><pre class=\"codeblock brush:apex\"><span class=\"keyword\">public</span> <span class=\"keyword\">static</span> <span class=\"keyword\">void</span> applyDiscount(Book__c[] books) {\n <span class=\"statement\">for</span> (Book__c b :books){\n b.Price__c *= 0.9;\n }\n}\n</pre></div>\n\n </div>\n <div class=\"itemgroup info\">\n <p class=\"p\">This method is called <samp class=\"codeph apex_code\">applyDiscount</samp>,\n and it is both public and static. Because it is a static method, you don't\n need to create an instance of the class to access the method—you can\n just use the name of the class followed by a dot (.) and the name of the\n method. For more information, see <a class=\"xref\" href=\"atlas.en-us.apexcode.meta/apexcode/apex_classes_static.htm\" title=\"In Apex, you can have static methods, variables, and initialization code. However, Apex classes can’t be static. You can also have instance methods, member variables, and initialization code, which have no modifier, and local variables.\">Static and Instance Methods, Variables, and Initialization\n Code</a>.</p>\n\n <p class=\"p\">This method takes one parameter, a list of Book records, which is assigned to\n the variable <samp class=\"codeph apex_code\">books</samp>. Notice the\n <samp class=\"codeph apex_code\">__c</samp> in the object name <samp class=\"codeph apex_code\">Book__c</samp>. This indicates that it is a\n <dfn class=\"term\">custom object</dfn> that you created. Standard objects that are\n provided in the Salesforce application, such as Account, don't end with this\n postfix.</p>\n\n <p class=\"p\">The next section of code contains the rest of the method definition:</p>\n\n <div class=\"codeSection apex_code\"><pre class=\"codeblock brush:apex\"><span class=\"statement\">for</span> (Book__c b :books){\n b.Price__c *= 0.9;\n}\n</pre></div>\n\n <p class=\"p\">Notice the <samp class=\"codeph apex_code\">__c</samp> after the field name\n <samp class=\"codeph apex_code\">Price__c</samp>. This indicates it is\n a <dfn class=\"term\">custom field</dfn> that you created. Standard fields that are\n provided by default in Salesforce are accessed using the same type of dot\n notation but without the <samp class=\"codeph apex_code\">__c</samp>, for\n example, <samp class=\"codeph apex_code\">Name</samp> doesn't end with\n <samp class=\"codeph apex_code\">__c</samp> in <samp class=\"codeph apex_code\">Book__c.Name</samp>. The statement <samp class=\"codeph apex_code\">b.Price__c *= 0.9;</samp> takes the old value\n of <samp class=\"codeph apex_code\">b.Price__c</samp>, multiplies it by 0.9,\n which means its value will be discounted by 10%, and then stores the new\n value into the <samp class=\"codeph apex_code\">b.Price__c</samp> field. The\n <samp class=\"codeph apex_code\">*=</samp> operator is a shortcut.\n Another way to write this statement is <samp class=\"codeph apex_code\">b.Price__c = b.Price__c * 0.9;</samp>. See <a class=\"xref\" href=\"atlas.en-us.apexcode.meta/apexcode/langCon_apex_expressions_operators_understanding.htm\" title=\"Expressions can be joined to one another with operators to create compound expressions.\">Expression Operators</a>.</p>\n\n </div>\n </li>\n\n <li class=\"li step\">\n <span class=\"ph cmd\">Click <strong class=\"ph uicontrol\">Save</strong> to save the new class. You should now have\n this full class definition.</span>\n <div class=\"itemgroup stepxmp\">\n <div class=\"codeSection apex_code\"><pre class=\"codeblock brush:apex\"><span class=\"keyword\">public</span> <span class=\"keyword\">class</span> MyHelloWorld {\n <span class=\"keyword\">public</span> <span class=\"keyword\">static</span> <span class=\"keyword\">void</span> applyDiscount(Book__c[] books) {\n <span class=\"statement\">for</span> (Book__c b :books){\n b.Price__c *= 0.9;\n }\n }\n}</pre></div>\n\n </div>\n </li>\n\n </ol>\n\n <div class=\"section result\"><div class=\"p\">You now have a class that contains some code that iterates over a list of books and\n updates the Price field for each book. This code is part of the <samp class=\"codeph apex_code\">applyDiscount</samp> static method called by the trigger\n that you will create in the next step.</div></div>\n\n </div><div id=\"sfdc:seealso\" class=\"related-links\">\n<div class=\"pagination pagination-centered\"><ul class=\"pagination\">\n<li class=\"previous_page\"><a class=\"link\" href=\"atlas.en-us.apexcode.meta/apexcode/apex_qs_customobject.htm\" title=\"Create a Custom Object\">← Previous</a></li>\n<li class=\"next_page\"><a class=\"link\" href=\"atlas.en-us.apexcode.meta/apexcode/apex_qs_trigger.htm\" title=\"Add an Apex Trigger\">Next →</a></li>\n</ul></div>\n</div>"
5
- }
@@ -1,29 +0,0 @@
1
- export default `<a name="apex_dev_guide"><!-- --></a><h1 class="helpHead1">Apex Developer Guide</h1><div class="shortdesc">Salesforce has changed the way organizations do business by moving enterprise
2
- applications that were traditionally client-server-based into the Lightning Platform, an
3
- on-demand, multitenant Web environment. This environment enables you to run and customize
4
- applications, such as Salesforce Automation and Service &amp; Support, and build new custom
5
- applications based on particular business needs. </div><div id="sfdc:seealso" class="related-links">
6
- <ul class="ullinks">
7
- <li class="link ulchildlink">
8
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_intro_get_started.htm">Getting Started with Apex</a></strong><br>
9
- Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Lightning Platform server, in conjunction with calls to the API.</li>
10
- <li class="link ulchildlink">
11
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_writing.htm">Writing Apex</a></strong><br>
12
- Apex is like Java for Salesforce. It enables you to add and interact with data in the Lightning Platform persistence layer. It uses classes, data types, variables, and if-else statements. You can make it execute based on a condition, or have a block of code execute repeatedly.</li>
13
- <li class="link ulchildlink">
14
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_running.htm">Running Apex</a></strong><br>
15
- You can access many features of the Salesforce user interface programmatically in Apex, and you can integrate with external SOAP and REST Web services. You can run Apex code using a variety of mechanisms. Apex code runs in atomic transactions. </li>
16
- <li class="link ulchildlink">
17
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_debug_test_deploy.htm">Debugging, Testing, and Deploying Apex</a></strong><br>
18
- Develop your Apex code in a sandbox and debug it with the Developer Console and debug logs. Unit-test your code, then distribute it to customers using packages.</li>
19
- <li class="link ulchildlink">
20
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_reference.htm">Apex Language Reference</a></strong><br>
21
- This Apex reference goes into detail about DML statements and the built-in Apex classes and interfaces.</li>
22
- <li class="link ulchildlink">
23
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_appendices.htm">Appendices</a></strong><br>
24
- </li>
25
- <li class="link ulchildlink">
26
- <strong><a href="atlas.en-us.apexcode.meta/apexcode/glossary_apex.htm">Glossary</a></strong><br>
27
- </li>
28
- </ul>
29
- </div><!--DRC 228.7-->`;