Skip to content

Commit

Permalink
docs: update docs on notexistent button variants
Browse files Browse the repository at this point in the history
  • Loading branch information
smallTrogdor committed Dec 10, 2024
1 parent 8fd07b3 commit 75c194c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 23 deletions.
19 changes: 6 additions & 13 deletions lib/src/button/sbb_icon_button.dart
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ class SBBIconButtonLarge extends StatelessWidget {
///
/// The [icon] parameter must not be null. Make sure to use small icons
/// ([sbbIconSizeSmall] - 24x24).
///
/// If [onPressed] callback is null, then the button will be disabled.
///
/// See also:
Expand Down Expand Up @@ -93,17 +92,14 @@ class SBBIconButtonSmall extends StatelessWidget {
}
}

/// Small negative variant of the SBB Icon Button. Use according to
/// documentation.
/// Negative variant of the [SBBIconButtonSmall].
///
/// THIS IS NOT IN THE MOBILE DESIGN SPECS. Can be removed in a future version.
///
/// The [icon] parameter must not be null. Make sure to use small icons
/// ([sbbIconSizeSmall] - 24x24).
///
/// If [onPressed] callback is null, then the button will be disabled.
///
/// See also:
///
/// * <https://digital.sbb.ch/de/design-system-mobile-new/elemente/button>
class SBBIconButtonSmallNegative extends StatelessWidget {
const SBBIconButtonSmallNegative({
super.key,
Expand All @@ -128,17 +124,14 @@ class SBBIconButtonSmallNegative extends StatelessWidget {
}
}

/// Small borderless variant of the SBB Icon Button. Use according to
/// documentation.
/// Borderless variant of the [SBBIconButtonSmall].
///
/// THIS IS NOT IN THE MOBILE DESIGN SPECS. Can be removed in a future version.
///
/// The [icon] parameter must not be null. Make sure to use small icons
/// ([sbbIconSizeSmall] - 24x24).
///
/// If [onPressed] callback is null, then the button will be disabled.
///
/// See also:
///
/// * <https://digital.sbb.ch/de/design-system-mobile-new/elemente/button>
class SBBIconButtonSmallBorderless extends StatelessWidget {
const SBBIconButtonSmallBorderless({
super.key,
Expand Down
8 changes: 3 additions & 5 deletions lib/src/button/sbb_icon_form_button.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@ import 'package:flutter/material.dart';

import '../../sbb_design_system_mobile.dart';

/// The SBB Icon Form Button. Use according to documentation.
/// The SBB Icon Form Button.
///
/// THIS IS NOT IN THE MOBILE DESIGN SPECS. Can be removed in a future version.
///
/// The [icon] parameter must not be null. Make sure to use small icons
/// ([sbbIconSizeSmall] - 24x24).
///
/// If [onPressed] callback is null, then the button will be disabled.
///
/// See also:
///
/// * <https://digital.sbb.ch/de/design-system-mobile-new/elemente/button>
class SBBIconFormButton extends StatelessWidget {
const SBBIconFormButton({
super.key,
Expand Down
8 changes: 3 additions & 5 deletions lib/src/button/sbb_primary_button.dart
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,16 @@ class SBBPrimaryButton extends StatelessWidget {
}
}

/// Negative variant of the SBB Primary Button. Use according to documentation.
/// Negative variant of the [SBBPrimaryButton].
///
/// THIS IS NOT IN THE MOBILE DESIGN SPECS. Can be removed in a future version.
///
/// The [label] parameter must not be null.
///
/// If [isLoading] is true, then the [SBBLoadingIndicator] will be displayed
/// inside the button and the [onPressed] callback will be ignored.
///
/// If [onPressed] callback is null, then the button will be disabled.
///
/// See also:
///
/// * <https://digital.sbb.ch/de/design-system-mobile-new/elemente/button>
class SBBPrimaryButtonNegative extends StatelessWidget {
const SBBPrimaryButtonNegative({
super.key,
Expand Down

0 comments on commit 75c194c

Please sign in to comment.