progressbar.d.ts 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. import { NgbProgressbarConfig } from './progressbar-config';
  2. /**
  3. * A directive that provides feedback on the progress of a workflow or an action.
  4. */
  5. export declare class NgbProgressbar {
  6. private _max;
  7. /**
  8. * The maximal value to be displayed in the progress bar.
  9. *
  10. * Should be a positive number. Will default to 100 otherwise.
  11. */
  12. max: number;
  13. /**
  14. * If `true`, the stripes on the progress bar are animated.
  15. *
  16. * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
  17. */
  18. animated: boolean;
  19. /**
  20. * If `true`, the progress bars will be displayed as striped.
  21. */
  22. striped: boolean;
  23. /**
  24. * If `true`, the current percentage will be shown in the `xx%` format.
  25. */
  26. showValue: boolean;
  27. /**
  28. * Optional text variant type of the progress bar.
  29. *
  30. * Supports types based on Bootstrap background color variants, like:
  31. * `"success"`, `"info"`, `"warning"`, `"danger"`, `"primary"`, `"secondary"`, `"dark"` and so on.
  32. *
  33. * @since 5.2.0
  34. */
  35. textType: string;
  36. /**
  37. * The type of the progress bar.
  38. *
  39. * Supports types based on Bootstrap background color variants, like:
  40. * `"success"`, `"info"`, `"warning"`, `"danger"`, `"primary"`, `"secondary"`, `"dark"` and so on.
  41. */
  42. type: string;
  43. /**
  44. * The current value for the progress bar.
  45. *
  46. * Should be in the `[0, max]` range.
  47. */
  48. value: number;
  49. /**
  50. * The height of the progress bar.
  51. *
  52. * Accepts any valid CSS height values, ex. `"2rem"`
  53. */
  54. height: string;
  55. constructor(config: NgbProgressbarConfig);
  56. getValue(): number;
  57. getPercentValue(): number;
  58. }