_gss.scss 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. //
  2. // Copyright 2020 Google Inc.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. @use 'sass:list';
  23. @use 'sass:map';
  24. @use 'sass:meta';
  25. /// Adds optional GSS annotation comments. Useful for theme mixins where one or
  26. /// more properties are set indirectly.
  27. ///
  28. /// Annotations may be provided as a Map of annotations or as named arguments.
  29. ///
  30. /// @example - scss
  31. /// @include annotate((noflip: true));
  32. /// left: 0;
  33. ///
  34. /// @example - scss
  35. /// @include annotate($noflip: true);
  36. /// left: 0;
  37. ///
  38. /// @example - css
  39. /// /* @noflip */ /*rtl:ignore*/
  40. /// left: 0;
  41. ///
  42. /// @param {Map} $annotations - Map of annotations. Values must be set to `true`
  43. /// for an annotation to be added.
  44. @mixin annotate($annotations...) {
  45. $keywords: meta.keywords($annotations);
  46. @if list.length($annotations) > 0 {
  47. $annotations: list.nth($annotations, 1);
  48. } @else {
  49. $annotations: $keywords;
  50. }
  51. @if (map.get($annotations, alternate) == true) {
  52. /* @alternate */
  53. }
  54. // noflip must be the last tag right before the property
  55. @if (map.get($annotations, noflip) == true) {
  56. /* @noflip */ /*rtl:ignore*/
  57. }
  58. }