Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add new InformationHighlight component to Preview #3015

Merged
merged 36 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
b9e9522
feat: move info highlight to preview react, build story book, add hig…
Oct 30, 2024
31c266c
feat: added visual testing
Oct 30, 2024
fc36535
fix: update Tokens.mdx to call info highlight properly
Oct 30, 2024
f31b709
feat: added in test for custom icons
Oct 30, 2024
3be85fd
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Nov 4, 2024
45702fb
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Nov 4, 2024
73a16a2
feat: RTL testing
Nov 7, 2024
e59aa7a
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Dec 9, 2024
7ff9437
updated export in testing.stories.tsx
Dec 10, 2024
3f9cb39
consolidated examples and added info on emphases
Dec 10, 2024
c1cad00
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Dec 10, 2024
41b376d
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Dec 17, 2024
44f8c57
PR review tidying
Dec 18, 2024
d2f4317
updated examples
Dec 19, 2024
78986e3
updated visual test
Dec 27, 2024
c3ba4c0
Merge branch 'prerelease/minor' of https://github.com/Workday/canvas-…
Dec 27, 2024
bfef7b3
cypress updates
Dec 30, 2024
197eb16
render test
Dec 30, 2024
b60f98a
story updates
Dec 30, 2024
f59c758
fixed wording
Dec 31, 2024
0e88b6d
icon updates
Jan 2, 2025
4f81b0c
pr updates
Jan 3, 2025
b876344
clean up unnecessary exports
Jan 3, 2025
8aba4b3
small clean up
Jan 3, 2025
e6d7c09
export parts
Jan 3, 2025
8bc439a
update to stencils
Jan 3, 2025
a68b7cc
hyperlink to tertiary button
Jan 6, 2025
064d6d8
update hyperlink component
Jan 6, 2025
b0a3aa0
colors
Jan 6, 2025
c5a3458
more colors
Jan 6, 2025
abd155c
focus
Jan 7, 2025
60adc1a
pr comments
Jan 7, 2025
1351eeb
boarder radius
Jan 7, 2025
11810cd
Merge branch 'prerelease/minor' into info_highlight_creation
josh-bagwell Jan 7, 2025
51cb3a8
Merge branch 'prerelease/minor' into info_highlight_creation
josh-bagwell Jan 7, 2025
9b78d2e
Merge branch 'prerelease/minor' into info_highlight_creation
mannycarrera4 Jan 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions cypress/component/InformationHighlight.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import * as React from 'react';
import {Informational} from '../../modules/preview-react/InformationHighlight/stories/examples/Informational';
import {Caution} from '../../modules/preview-react/InformationHighlight/stories/examples/Caution';
import {Critical} from '../../modules/preview-react/InformationHighlight/stories/examples/Critical';

describe('Information Highlight', () => {
[Informational, Caution, Critical].forEach(Example => {
context(`${Example.name} Example`, () => {
beforeEach(() => {
cy.mount(<Example />);
});

it('should pass axe checks', () => {
cy.checkA11y();
});

it('should have an element with a role of "heading"', () => {
cy.findAllByRole('heading').should('be.visible');
});
});
});
});
1 change: 0 additions & 1 deletion modules/docs/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
export {ExampleCodeBlock} from './lib/ExampleCodeBlock';
export * from './lib/specs';
export * from './lib/InformationHighlight';
export * from './lib/Specifications';
export * from './lib/StylePropsTable';
export * from './lib/docs';
Expand Down
12 changes: 0 additions & 12 deletions modules/docs/lib/InformationHighlight/Base.tsx

This file was deleted.

21 changes: 0 additions & 21 deletions modules/docs/lib/InformationHighlight/Body.tsx

This file was deleted.

20 changes: 0 additions & 20 deletions modules/docs/lib/InformationHighlight/Heading.tsx

This file was deleted.

65 changes: 0 additions & 65 deletions modules/docs/lib/InformationHighlight/Icon.tsx

This file was deleted.

20 changes: 0 additions & 20 deletions modules/docs/lib/InformationHighlight/Link.tsx

This file was deleted.

62 changes: 0 additions & 62 deletions modules/docs/lib/InformationHighlight/index.tsx

This file was deleted.

51 changes: 51 additions & 0 deletions modules/preview-react/InformationHighlight/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Apache License, Version 2.0 Apache License Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License.
Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License.
Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution.
You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions.
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks.
This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty.
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability.
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability.
While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

©2020. Workday, Inc. All rights reserved. Workday and the Workday logo are registered trademarks of Workday, Inc. All other brand and product names are trademarks or registered trademarks of their respective holders.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
10 changes: 10 additions & 0 deletions modules/preview-react/InformationHighlight/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Canvas Kit Information Highlight

<a href="https://github.com/Workday/canvas-kit/tree/master/modules/preview-react/README.md">
<img src="https://img.shields.io/badge/PREVIEW-beta-blueviolet" alt="PREVIEW: Beta" />
</a> This component is work in progress and currently in prerelease.

A information highlight component to highlight and prioritize content

View the [documentation for Information Highlight](LINK_HERE)
on Storybook.
josh-bagwell marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 5 additions & 0 deletions modules/preview-react/InformationHighlight/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export * from './lib/InformationHighlight';
niftea marked this conversation as resolved.
Show resolved Hide resolved
export * from './lib/parts/Body';
export * from './lib/parts/Heading';
export * from './lib/parts/Icon';
export * from './lib/parts/Link';
Loading
Loading